Skip to content

Commit

Permalink
fix(sdk): resolve various broken references to docmaps-sdk
Browse files Browse the repository at this point in the history
  • Loading branch information
ships committed Dec 18, 2023
1 parent 40e2c86 commit 3be5aef
Show file tree
Hide file tree
Showing 6 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion packages/etl/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ pnpm docmaps-etl item --source crossref-api 10.5194/angeo-40-247-2022 # or npm d

## Implementation

This tool and library are written using the [`docmaps-sdk` package](/packages/sdk)
This tool and library are written using the [`@docmaps/sdk` package](/packages/sdk)
in this repository, as well as the [`crossref-openapi-client-ts`](https://github.com/Docmaps-Project/crossref-openapi-client-ts)
also maintained by Knowledge Futures, Inc. As seen in `src/crossref.ts`[src/crossref.ts],
Codecs from the SDK are processed using functional paradigms provided conveniently by
Expand Down
6 changes: 3 additions & 3 deletions packages/example/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Example: Using `docmaps-sdk` and `fp-ts` to Parse and Validate Docmaps
# Example: Using `@docmaps/sdk` and `fp-ts` to Parse and Validate Docmaps

Welcome to `example`. This project demonstrates how to parse and validate docmaps using `docmaps-sdk` and `fp-ts`.
Welcome to `example`. This project demonstrates how to parse and validate docmaps using `@docmaps/sdk` and `fp-ts`.

The demonstration aims to provide a starting point and guide for developers who want to use these libraries to manage docmaps effectively in their applications.
Mainly it exists so you can inspect the code and replicate the pattern. See comments inline
Expand All @@ -16,7 +16,7 @@ for details.

## Usage

Please refer to the `docmaps-sdk` and `fp-ts` documentation for more detailed information on usage and functionality.
Please refer to the `@docmaps/sdk` and `fp-ts` documentation for more detailed information on usage and functionality.

## License

Expand Down
2 changes: 1 addition & 1 deletion packages/http-server/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ RUN --mount=type=cache,id=pnpm,target=/pnpm/store \
--frozen-lockfile

# Build the dependencies from this workspace
RUN pnpm --filter docmaps-sdk --filter @docmaps/http-client run build
RUN pnpm --filter @docmaps/sdk --filter @docmaps/http-client run build
# Build the application
RUN pnpm --filter @docmaps/http-server run build

Expand Down
2 changes: 1 addition & 1 deletion packages/http-server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The package/server is structured like this:
| HTTP webserver | using [express.js](https://expressjs.com/), fulfills contract described in [the RFC for this server](https://github.com/Docmaps-Project/rfcs/blob/ships/1/APIProtocol/proposals/001_interop.md) |
| Node API Instance | fulfills contract spec of the RFC in nodejs library. `src/api.ts` |
| Adapter layer | Separates the dataset adapter from the API instance for example, isolates auth from data `src/adapter/` |
| SPARQL processor/adapter | converts Docmaps semantics to SPARQL and uses `docmaps-sdk` to make objects from triples |
| SPARQL processor/adapter | converts Docmaps semantics to SPARQL and uses `@docmaps/sdk` to make objects from triples |
| SPARQL triplestore | Anything that supports SPARQL is allowed, we supply easy access to [oxigraph](https://github.com/oxigraph/oxigraph) |

Note that use of SPARQL is optional but you would be required to write your own `BackendAdapter` layer that translates
Expand Down
2 changes: 1 addition & 1 deletion packages/sdk/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ as the results of a SPARQL query.

## Documentation

Documentation is [served by github pages](https://docmaps-project.github.io/docmaps/docmaps-sdk/index.html).
Documentation is [served by github pages](https://docmaps-project.github.io/docmaps/sdk/index.html).
If you wish to view documentation for an off-branch edition of this package, the directory `/docs`
can be populated by the command `pnpm docs:generate`. The inputs to the
generation script include all Markdown and source files in this directory. These docs are generated
Expand Down
2 changes: 1 addition & 1 deletion packages/sdk/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
"lint:fix": "eslint --fix .",
"docs:generate": "typedoc src/index.ts",
"clean": "rm -rf dist/",
"build:deps": "pnpm run --filter=docmaps-sdk^... build",
"build:deps": "pnpm run --filter=@docmaps/sdk^... build",
"build": "tsc --declaration"
},
"engines": {
Expand Down

0 comments on commit 3be5aef

Please sign in to comment.