@ecrvs/opencrvs-toolkit 1.8.1-rc.11dbd54

package/README.md

@@ -0,0 +1,70 @@
+# OpenCRVS toolkit
+
+OpenCRVS toolkit for building country configurations.
+
+## File structure
+
+```
+src/
+  events/ # re-exports events module from commons package
+  scopes/ # re-exports scopes module from commons package
+  conditionals/ # provides tools for easily formulating complex conditionals and deduplication rules
+  api/ # provides an API wrapper for OpenCRVS APIs with strict typing and validation
+```
+
+## Getting started
+
+### Development using yarn link
+
+```
+# tsconfig.json references commons. when `tsc --build` is run, both are built.
+> yarn build:all
+# If you miss this part you might face issues with types.
+> cd dist
+> yarn link
+```
+
+### Internal dependencies
+
+When adding internal package as dependency, understand that:
+
+- Internal packages cannot be direct dependencies. Toolkit is published through npm, and dependency cannot be resolved.
+- Packages may have dependencies that require strict order of installation. Ensure installations are run in proper order in pipeline and scripts.
+
+#### @opencrvs/events
+
+Toolkit "re-exports" TRPC router to allow for easy client interaction.
+
+#### @opencrvs/commons
+
+Toolkit "re-exports" common definitions (e.g. events, conditionals) and make them available through npm.
+
+### Releasing and buiding
+
+#### While developing
+
+1. Update version number in `package.json`
+2. `yarn build:all`
+3. `npm publish`
+
+#### Through version control
+
+1. Update version number in `package.json`
+2. Create a pull request
+3. Once merged, github action will get triggered.
+
+#### Gotchas, good to know
+
+- All dependencies of the functions and moduless used from `packages/commons` **must** be also defined in the package.json of the toolkit. Otherwise someone installing the package will get errors.
+- Package is published and should be used without knowledge of rest of the monorepo
+- Package exposes `/events, /scopes` directory, with types, from `packages/commons` through the library, others are excluded.
+- If the above directories have subdirectories, the types are not exposed by default. The compiled JavaScript is available though through `esbuild`. See `build.sh` on how to expose subdirectories:
+
+```sh
+# Build common events
+npx esbuild src/events/index.ts --bundle --format=cjs --outdir=./dist/events --allow-overwrite --packages=external
+mkdir -p ./dist/commons/events
+cp -r ../commons/build/dist/common/events/*.d.ts ./dist/commons/events
+mkdir -p ./dist/commons/events/state # <-- create the subdirectory
+cp -r ../commons/build/dist/common/events/state/*.d.ts ./dist/commons/events/state # <-- copy the types over
+```

package/build.sh

@@ -0,0 +1,56 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at https://mozilla.org/MPL/2.0/.
+#
+# OpenCRVS is also distributed under the terms of the Civil Registration
+# & Healthcare Disclaimer located at http://opencrvs.org/license.
+#
+# Copyright (C) The OpenCRVS Authors located at https://github.com/opencrvs/opencrvs-core/blob/master/AUTHORS.
+
+#!/bin/bash
+
+set -e
+
+rm -rf dist
+
+npx tsc --build
+
+# Build common events
+npx esbuild src/events/index.ts --bundle --format=cjs --outdir=./dist/events --allow-overwrite --packages=external
+mkdir -p ./dist/commons/events
+cp -r ../commons/build/dist/common/events/*.d.ts ./dist/commons/events
+mkdir -p ./dist/commons/events/state
+cp -r ../commons/build/dist/common/events/state/*.d.ts ./dist/commons/events/state
+
+# Build common conditionals
+npx esbuild src/conditionals/index.ts --bundle --format=cjs --outdir=./dist/conditionals --allow-overwrite --packages=external
+mkdir -p ./dist/commons/conditionals
+cp -r ../commons/build/dist/common/conditionals/*.d.ts ./dist/commons/conditionals
+
+# Build common scopes
+npx esbuild src/scopes/index.ts --bundle --format=cjs --outdir=./dist/scopes --allow-overwrite --packages=external
+cp -r ../commons/build/dist/common/scopes.d.ts ./dist/scopes/index.d.ts
+
+# Build api client
+npx esbuild src/api/index.ts --bundle --format=cjs --outdir=./dist/api --allow-overwrite --packages=external
+mkdir -p ./dist/commons/api
+cp -r ../events/build/types/router/router.d.ts ./dist/commons/api
+
+# Build deduplication api
+npx esbuild src/events/deduplication.ts --bundle --format=cjs --outdir=./dist/events --allow-overwrite --packages=external
+cp -r ../commons/build/dist/common/events/deduplication.d.ts ./dist/events/deduplication.d.ts
+
+# Build common notifications
+npx esbuild src/notification/index.ts --bundle --format=cjs --outdir=./dist/notification --allow-overwrite --packages=external
+mkdir -p ./dist/commons/notification
+cp -r ../commons/build/dist/common/notification/*.d.ts ./dist/commons/notification
+
+if [[ "$OSTYPE" == "darwin"* ]]; then
+  sed -i '' 's|@opencrvs/events/build/types|../commons/api|g' dist/api/index.d.ts
+  find dist -type f -exec sed -i '' 's|@opencrvs/commons|../commons|g' {} +
+else
+  sed -i 's|@opencrvs/events/build/types|../commons/api|g' dist/api/index.d.ts
+  find dist -type f -exec sed -i 's|@opencrvs/commons|../commons|g' {} +
+fi
+
+echo "Build completed successfully."

package/dist/api/index.d.ts

@@ -0,0 +1,11 @@
+import { CreateTRPCClient } from '@trpc/client';
+import { AppRouter } from '../commons/api/router';
+/**
+ * Creates a tRPC client with the specified base URL and authorization token.
+ *
+ * @param baseUrl - The base URL where the tRPC server can be found, e.g., 'https://farajaland.opencrvs.org/api/trpc'.
+ * @param token - The authorization token to be used in the request headers.
+ * @returns A tRPC client configured with the provided base URL and authorization token.
+ */
+export declare function createClient(baseUrl: string, token: `Bearer ${string}`): CreateTRPCClient<AppRouter>;
+//# sourceMappingURL=index.d.ts.map

package/dist/api/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,gBAAgB,EAAmC,MAAM,cAAc,CAAA;AAEhF,OAAO,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAA;AAE/D;;;;;;GAMG;AACH,wBAAgB,YAAY,CAC1B,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,UAAU,MAAM,EAAE,GACxB,gBAAgB,CAAC,SAAS,CAAC,CAc7B"}

package/dist/api/index.js

@@ -0,0 +1,52 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/api/index.ts
+var api_exports = {};
+__export(api_exports, {
+  createClient: () => createClient
+});
+module.exports = __toCommonJS(api_exports);
+var import_client = require("@trpc/client");
+var import_superjson = __toESM(require("superjson"));
+function createClient(baseUrl, token) {
+  return (0, import_client.createTRPCClient)({
+    links: [
+      (0, import_client.httpBatchLink)({
+        url: baseUrl,
+        transformer: import_superjson.default,
+        headers() {
+          return {
+            Authorization: token
+          };
+        }
+      })
+    ]
+  });
+}