From 3be5aef5b938c95ea06c64830bdc3df2caeaae9a Mon Sep 17 00:00:00 2001 From: "eve n.u." Date: Mon, 18 Dec 2023 15:05:14 -0800 Subject: [PATCH] fix(sdk): resolve various broken references to docmaps-sdk --- packages/etl/README.md | 2 +- packages/example/README.md | 6 +++--- packages/http-server/Dockerfile | 2 +- packages/http-server/README.md | 2 +- packages/sdk/README.md | 2 +- packages/sdk/package.json | 2 +- 6 files changed, 8 insertions(+), 8 deletions(-) diff --git a/packages/etl/README.md b/packages/etl/README.md index 2394ba09..276deb89 100644 --- a/packages/etl/README.md +++ b/packages/etl/README.md @@ -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 diff --git a/packages/example/README.md b/packages/example/README.md index 73d91fc6..d3a40a05 100644 --- a/packages/example/README.md +++ b/packages/example/README.md @@ -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 @@ -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 diff --git a/packages/http-server/Dockerfile b/packages/http-server/Dockerfile index fe86ba06..cef9bed3 100644 --- a/packages/http-server/Dockerfile +++ b/packages/http-server/Dockerfile @@ -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 diff --git a/packages/http-server/README.md b/packages/http-server/README.md index 6169b249..74d07eeb 100644 --- a/packages/http-server/README.md +++ b/packages/http-server/README.md @@ -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 diff --git a/packages/sdk/README.md b/packages/sdk/README.md index e5a9c5a0..853f1854 100644 --- a/packages/sdk/README.md +++ b/packages/sdk/README.md @@ -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 diff --git a/packages/sdk/package.json b/packages/sdk/package.json index 378ed124..8989143a 100644 --- a/packages/sdk/package.json +++ b/packages/sdk/package.json @@ -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": {