@ogcio/building-blocks-sdk 0.0.1

package/src/clients-configurations/read-configuration-file.ts

@@ -0,0 +1,68 @@
+import { type Static, Type } from "@sinclair/typebox";
+import { Value } from "@sinclair/typebox/value";
+
+export enum OpenAPIFileFormats {
+  JSON = "json",
+  YAML = "yaml",
+}
+
+const ConfigurationBuildingBlockSchema = Type.Object({
+  name: Type.String(),
+  openApiDefinitionUrl: Type.String(),
+  openApiDefinitionFormat: Type.Enum(OpenAPIFileFormats),
+  citizenPermissions: Type.Array(Type.String(), { default: [] }),
+  publicServantPermissions: Type.Array(Type.String(), { default: [] }),
+  updateDefinitions: Type.Boolean({ default: true }),
+});
+
+export type ConfigurationBuildingBlock = Static<
+  typeof ConfigurationBuildingBlockSchema
+>;
+
+const InputFileSchema = Type.Object({
+  buildingBlocks: Type.Array(ConfigurationBuildingBlockSchema),
+});
+
+type ConfigurationFile = {
+  buildingBlocks: { [x: string]: ConfigurationBuildingBlock };
+};
+
+function ensureBuildingBlockNameIsValid(bbName: string) {
+  // The building block name must only contain letters
+  // so its name can be used to get it using dot notation
+  // in code. E.g. sdkClient.messaging, where messaging
+  // is the name of the BB
+  const regex = /^[a-zA-Z]+$/g;
+  if (!regex.test(bbName))
+    throw new Error(
+      `A building block name can only contain letters, ${bbName} is not valid`,
+    );
+}
+
+export async function readConfigurationFile(
+  configurationFilePath: string,
+): Promise<ConfigurationFile> {
+  const { default: rawConfigurationFile } = await import(
+    configurationFilePath,
+    {
+      assert: {
+        type: "json",
+      },
+    }
+  );
+
+  const parsedFile = Value.Parse(InputFileSchema, rawConfigurationFile);
+
+  // Why do not directly create an object where the service name
+  // is the key in the configuration file instead of an array?
+  // To avoid having unexpected behaviours on naming
+  // e.g. Adding a "messaging-api" entry could return
+  // "messagingApi" when parsing
+  const outputFile: ConfigurationFile = { buildingBlocks: {} };
+  for (const parsedBlock of parsedFile.buildingBlocks) {
+    ensureBuildingBlockNameIsValid(parsedBlock.name);
+    outputFile.buildingBlocks[parsedBlock.name] = parsedBlock;
+  }
+
+  return outputFile;
+}

package/src/index.ts

@@ -0,0 +1,43 @@
+import Messaging from "./client/clients/messaging/index.js";
+import Payments from "./client/clients/payments/index.js";
+import Profile from "./client/clients/profile/index.js";
+import Scheduler from "./client/clients/scheduler/index.js";
+import Upload from "./client/clients/upload/index.js";
+
+export type { BuildingBlocksSDK } from "./types/index.js";
+export { default as getM2MTokenFn } from "./client/auth/index.js";
+
+import type {
+  BuildingBlockSDKParams,
+  BuildingBlocksSDK,
+} from "./types/index.js";
+
+const getBuildingBlockSDK = (
+  params: BuildingBlockSDKParams,
+): BuildingBlocksSDK => {
+  const { services, getTokenFn } = params;
+  return {
+    messaging: new Messaging({
+      ...services.messaging,
+      getTokenFn,
+    }),
+    payments: new Payments({
+      ...services.payments,
+      getTokenFn,
+    }),
+    profile: new Profile({
+      ...services.payments,
+      getTokenFn,
+    }),
+    scheduler: new Scheduler({
+      ...services.scheduler,
+      getTokenFn,
+    }),
+    upload: new Upload({
+      ...services.upload,
+      getTokenFn,
+    }),
+  };
+};
+
+export default getBuildingBlockSDK;

package/src/logto-node.d.ts

@@ -0,0 +1,12 @@
+declare module "@logto/node" {
+  export enum UserScope {
+    Profile = "profile",
+    Email = "email",
+    Phone = "phone",
+    CustomData = "custom_data",
+    Identities = "identities",
+    Roles = "roles",
+    Organizations = "urn:logto:scope:organizations",
+    OrganizationRoles = "urn:logto:scope:organization_roles",
+  }
+}

package/src/types/index.ts

@@ -0,0 +1,82 @@
+import type Messaging from "../client/clients/messaging/index.js";
+import type Payments from "../client/clients/payments/index.js";
+import type Profile from "../client/clients/profile/index.js";
+import type Scheduler from "../client/clients/scheduler/index.js";
+import type Upload from "../client/clients/upload/index.js";
+
+export const MESSAGING = "messaging" as const;
+export const PAYMENTS = "payments" as const;
+export const PROFILE = "profile" as const;
+export const SCHEDULER = "scheduler" as const;
+export const UPLOAD = "upload" as const;
+
+export type SERVICE_NAME =
+  | typeof MESSAGING
+  | typeof PAYMENTS
+  | typeof PROFILE
+  | typeof SCHEDULER
+  | typeof UPLOAD;
+
+export type TokenFunction = (
+  serviceName: SERVICE_NAME,
+) => Promise<string> | string;
+
+export type M2MParams = {
+  getOrganizationTokenParams?: GetOrganizationTokenParams;
+  getAccessTokenParams?: GetAccessTokenParams;
+};
+
+export type M2MTokenFnConfig = {
+  services: {
+    [key in SERVICE_NAME]?: M2MParams;
+  };
+};
+
+export type SDKClientParams = {
+  baseUrl?: string;
+};
+
+export type ApiClientParams = SDKClientParams & {
+  getTokenFn?: TokenFunction;
+};
+
+type ServiceClients = {
+  messaging: Messaging;
+  payments: Payments;
+  profile: Profile;
+  scheduler: Scheduler;
+  upload: Upload;
+};
+
+export type BuildingBlocksSDK = {
+  [key in keyof ServiceClients]: ServiceClients[key];
+};
+
+export type BuildingBlockSDKParams = {
+  services: {
+    [key in keyof ServiceClients]?: SDKClientParams;
+  };
+  getTokenFn?: TokenFunction;
+};
+
+export interface TokenResponseBody {
+  access_token: string;
+  expires_in: number;
+  token_type: string;
+  scope: string;
+}
+
+interface GetTokenBaseParams {
+  logtoOidcEndpoint: string;
+  applicationId: string;
+  applicationSecret: string;
+  scopes?: string[];
+}
+
+export interface GetAccessTokenParams extends GetTokenBaseParams {
+  resource: string;
+}
+
+export interface GetOrganizationTokenParams extends GetTokenBaseParams {
+  organizationId: string;
+}

package/src/utils/get-absolute-path.ts

@@ -0,0 +1,10 @@
+import { dirname, resolve } from "path";
+import { fileURLToPath } from "url";
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+
+function getAbsolutePath(...relativeInputPath: string[]): string {
+  return resolve(__dirname, "..", "..", ...relativeInputPath);
+}
+
+export default getAbsolutePath;

package/tsconfig.json

@@ -0,0 +1,18 @@
+{
+  "compilerOptions": {
+    "target": "ESNext",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true,
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "outDir": "dist",
+    "rootDir": "src",
+    "resolveJsonModule": true
+  },
+  "include": ["./src"]
+}

package/tsconfig.prod.json

@@ -0,0 +1,4 @@
+{
+  "extends": "./tsconfig.json",
+  "exclude": ["__tests__", "dist", "./src/cli"]
+}