@ogcio/building-blocks-sdk 0.0.1

package/.husky/commit-msg

@@ -0,0 +1 @@
+npx --no -- commitlint --edit $1

package/.husky/pre-push

@@ -0,0 +1 @@
+# npm run build

package/.nvmrc

@@ -0,0 +1 @@
+lts/*

package/.vscode/settings.json

@@ -0,0 +1,20 @@
+{
+  "[typescript]": {
+    "editor.defaultFormatter": "biomejs.biome"
+  },
+  "[javascript]": {
+    "editor.defaultFormatter": "biomejs.biome"
+  },
+  "[jsonc]": {
+    "editor.defaultFormatter": "biomejs.biome"
+  },
+  "[json]": {
+    "editor.defaultFormatter": "biomejs.biome"
+  },
+  "editor.codeActionsOnSave": {
+    "quickfix.biome": "explicit",
+    "source.organizeImports.biome": "explicit"
+  },
+  "editor.formatOnSave": true,
+  "editor.formatOnPaste": true
+}

package/biome.jsonc

@@ -0,0 +1,45 @@
+{
+  "$schema": "https://biomejs.dev/schemas/1.9.3/schema.json",
+  "vcs": {
+    "enabled": false,
+    "clientKind": "git",
+    "useIgnoreFile": false
+  },
+  "files": {
+    "ignoreUnknown": false,
+    "ignore": [
+      "dist",
+      "node_modules",
+      "src/client/clients/**/*.json",
+      "src/client/clients/**/schema.ts"
+    ]
+  },
+  "formatter": {
+    "enabled": true,
+    "indentStyle": "space",
+    "indentWidth": 2
+  },
+  "organizeImports": {
+    "enabled": true
+  },
+  "linter": {
+    "enabled": true,
+    "rules": {
+      "recommended": true,
+      "correctness": {
+        "noUnusedVariables": {
+          "level": "error"
+        }
+      },
+      "style": {
+        "useTemplate": { "level": "warn", "fix": "safe" },
+        "useNodejsImportProtocol": "off"
+      }
+    }
+  },
+  "javascript": {
+    "formatter": {
+      "quoteStyle": "double"
+    }
+  }
+}

package/commitlint.config.js

@@ -0,0 +1,6 @@
+export default {
+  extends: ["@commitlint/config-conventional"],
+  rules: {
+    "scope-enum": [2, "always"],
+  },
+};

package/dist/client/auth/index.d.ts

@@ -0,0 +1,4 @@
+import type { M2MTokenFnConfig, TokenFunction } from "../../types/index.js";
+declare const getM2MTokenFn: (m2mTokenConfig: M2MTokenFnConfig) => TokenFunction;
+export default getM2MTokenFn;
+//# sourceMappingURL=index.d.ts.map

package/dist/client/auth/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/client/auth/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAGV,gBAAgB,EAEhB,aAAa,EAEd,MAAM,sBAAsB,CAAC;AAmF9B,QAAA,MAAM,aAAa,mBAAoB,gBAAgB,KAAG,aAqCzD,CAAC;AAEF,eAAe,aAAa,CAAC"}

package/dist/client/auth/index.js

@@ -0,0 +1,83 @@
+import configFile from "../../clients-configurations/clients-configuration.json";
+const fetchToken = async (params) => {
+    const body = {
+        ...params.specificBodyFields,
+        scope: params.scopes.join(" "),
+        grant_type: "client_credentials",
+    };
+    const logtoOidcEndpoint = params.logtoOidcEndpoint.endsWith("/")
+        ? params.logtoOidcEndpoint
+        : `${params.logtoOidcEndpoint}/`;
+    const response = await fetch(`${logtoOidcEndpoint}token`, {
+        method: "POST",
+        headers: {
+            "Content-Type": "application/x-www-form-urlencoded",
+            Authorization: `Basic ${Buffer.from(`${params.applicationId}:${params.applicationSecret}`).toString("base64")}`,
+        },
+        body: new URLSearchParams(body).toString(),
+    });
+    if (response.status !== 200) {
+        throw new Error("Unauthorized");
+    }
+    return response.json();
+};
+const getAccessToken = async (params, scopes) => {
+    const scopesToUse = params.scopes || scopes;
+    const tokenResponse = await fetchToken({
+        ...params,
+        scopes: scopesToUse,
+        specificBodyFields: { resource: params.resource },
+    });
+    return tokenResponse.access_token;
+};
+const getOrganizationToken = async (params, scopes) => {
+    const logtoUserScopes = await importUserScopes();
+    const { UserScope } = logtoUserScopes;
+    const scopesToUse = params.scopes || scopes;
+    const tokenResponse = await fetchToken({
+        ...params,
+        scopes: [
+            ...scopesToUse,
+            UserScope.OrganizationRoles,
+            UserScope.Organizations,
+        ],
+        specificBodyFields: {
+            organization_id: params.organizationId,
+        },
+    });
+    return tokenResponse.access_token;
+};
+const importUserScopes = async () => {
+    try {
+        const { UserScope } = await import("@logto/node");
+        return { UserScope };
+    }
+    catch {
+        throw new Error("@logto/node package is not installed!");
+    }
+};
+const getM2MTokenFn = (m2mTokenConfig) => {
+    const { services } = m2mTokenConfig;
+    const tokenFn = (serviceName) => {
+        const serviceParams = services[serviceName];
+        // const scopes = configFile.buildingBlocks[serviceName];
+        const serviceConfig = configFile.buildingBlocks.find(({ name }) => name === serviceName);
+        if (!serviceConfig) {
+            throw new Error(`Missing client config for ${serviceName}`);
+        }
+        if (!serviceParams) {
+            throw new Error(`Missing m2m config for ${serviceName}`);
+        }
+        const { getAccessTokenParams, getOrganizationTokenParams } = serviceParams;
+        if (getAccessTokenParams) {
+            return getAccessToken(getAccessTokenParams, serviceConfig.citizenPermissions);
+        }
+        if (getOrganizationTokenParams) {
+            return getOrganizationToken(getOrganizationTokenParams, serviceConfig.publicServantPermissions);
+        }
+        throw new Error(`wrong m2m config for ${serviceName}`);
+    };
+    return tokenFn;
+};
+export default getM2MTokenFn;
+//# sourceMappingURL=index.js.map

package/dist/client/auth/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/client/auth/index.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,yDAAyD,CAAC;AAUjF,MAAM,UAAU,GAAG,KAAK,EAAE,MAMzB,EAAE,EAAE;IACH,MAAM,IAAI,GAAG;QACX,GAAG,MAAM,CAAC,kBAAkB;QAC5B,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC;QAC9B,UAAU,EAAE,oBAAoB;KACjC,CAAC;IACF,MAAM,iBAAiB,GAAG,MAAM,CAAC,iBAAiB,CAAC,QAAQ,CAAC,GAAG,CAAC;QAC9D,CAAC,CAAC,MAAM,CAAC,iBAAiB;QAC1B,CAAC,CAAC,GAAG,MAAM,CAAC,iBAAiB,GAAG,CAAC;IACnC,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,iBAAiB,OAAO,EAAE;QACxD,MAAM,EAAE,MAAM;QACd,OAAO,EAAE;YACP,cAAc,EAAE,mCAAmC;YACnD,aAAa,EAAE,SAAS,MAAM,CAAC,IAAI,CACjC,GAAG,MAAM,CAAC,aAAa,IAAI,MAAM,CAAC,iBAAiB,EAAE,CACtD,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE;SACvB;QACD,IAAI,EAAE,IAAI,eAAe,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE;KAC3C,CAAC,CAAC;IAEH,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;QAC5B,MAAM,IAAI,KAAK,CAAC,cAAc,CAAC,CAAC;IAClC,CAAC;IAED,OAAO,QAAQ,CAAC,IAAI,EAAgC,CAAC;AACvD,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,KAAK,EAC1B,MAA4B,EAC5B,MAAgB,EAChB,EAAE;IACF,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,IAAI,MAAM,CAAC;IAE5C,MAAM,aAAa,GAAG,MAAM,UAAU,CAAC;QACrC,GAAG,MAAM;QACT,MAAM,EAAE,WAAW;QACnB,kBAAkB,EAAE,EAAE,QAAQ,EAAE,MAAM,CAAC,QAAQ,EAAE;KAClD,CAAC,CAAC;IACH,OAAO,aAAa,CAAC,YAAY,CAAC;AACpC,CAAC,CAAC;AAEF,MAAM,oBAAoB,GAAG,KAAK,EAChC,MAAkC,EAClC,MAAgB,EAChB,EAAE;IACF,MAAM,eAAe,GAAG,MAAM,gBAAgB,EAAE,CAAC;IAEjD,MAAM,EAAE,SAAS,EAAE,GAAG,eAAe,CAAC;IAEtC,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,IAAI,MAAM,CAAC;IAE5C,MAAM,aAAa,GAAG,MAAM,UAAU,CAAC;QACrC,GAAG,MAAM;QACT,MAAM,EAAE;YACN,GAAG,WAAW;YACd,SAAS,CAAC,iBAAiB;YAC3B,SAAS,CAAC,aAAa;SACxB;QACD,kBAAkB,EAAE;YAClB,eAAe,EAAE,MAAM,CAAC,cAAc;SACvC;KACF,CAAC,CAAC;IACH,OAAO,aAAa,CAAC,YAAY,CAAC;AACpC,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,KAAK,IAAI,EAAE;IAClC,IAAI,CAAC;QACH,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC,CAAC;QAElD,OAAO,EAAE,SAAS,EAAE,CAAC;IACvB,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;IAC3D,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,aAAa,GAAG,CAAC,cAAgC,EAAiB,EAAE;IACxE,MAAM,EAAE,QAAQ,EAAE,GAAG,cAAc,CAAC;IAEpC,MAAM,OAAO,GAAG,CAAC,WAAyB,EAAE,EAAE;QAC5C,MAAM,aAAa,GAAG,QAAQ,CAAC,WAAW,CAAC,CAAC;QAE5C,yDAAyD;QAEzD,MAAM,aAAa,GAAG,UAAU,CAAC,cAAc,CAAC,IAAI,CAClD,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,KAAK,WAAW,CACnC,CAAC;QAEF,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,MAAM,IAAI,KAAK,CAAC,6BAA6B,WAAW,EAAE,CAAC,CAAC;QAC9D,CAAC;QAED,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,MAAM,IAAI,KAAK,CAAC,0BAA0B,WAAW,EAAE,CAAC,CAAC;QAC3D,CAAC;QAED,MAAM,EAAE,oBAAoB,EAAE,0BAA0B,EAAE,GAAG,aAAa,CAAC;QAC3E,IAAI,oBAAoB,EAAE,CAAC;YACzB,OAAO,cAAc,CACnB,oBAAoB,EACpB,aAAa,CAAC,kBAAkB,CACjC,CAAC;QACJ,CAAC;QACD,IAAI,0BAA0B,EAAE,CAAC;YAC/B,OAAO,oBAAoB,CACzB,0BAA0B,EAC1B,aAAa,CAAC,wBAAwB,CACvC,CAAC;QACJ,CAAC;QAED,MAAM,IAAI,KAAK,CAAC,wBAAwB,WAAW,EAAE,CAAC,CAAC;IACzD,CAAC,CAAC;IACF,OAAO,OAAO,CAAC;AACjB,CAAC,CAAC;AAEF,eAAe,aAAa,CAAC"}

package/dist/client/base-client.d.ts

@@ -0,0 +1,18 @@
+import createClient, { type FetchResponse } from "openapi-fetch";
+import type { ApiClientParams, SERVICE_NAME, TokenFunction } from "../types/index.js";
+import type { DataResponseValue } from "./utils/client-utils.js";
+declare abstract class BaseClient<T extends {}> {
+    private baseUrl?;
+    private initialized;
+    protected token?: string;
+    protected getTokenFn?: TokenFunction;
+    protected serviceName: SERVICE_NAME | undefined;
+    protected client: ReturnType<typeof createClient<T>>;
+    constructor({ baseUrl, getTokenFn }: ApiClientParams);
+    protected getToken(): Promise<string | undefined>;
+    isInitialized(): boolean;
+    protected formatResponse<G, O>(response: FetchResponse<G, O, "application/json">): DataResponseValue<G, O>;
+    protected formatError<G, O>(reason: unknown): DataResponseValue<G, O>;
+}
+export default BaseClient;
+//# sourceMappingURL=base-client.d.ts.map

package/dist/client/base-client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base-client.d.ts","sourceRoot":"","sources":["../../src/client/base-client.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,EAAE,EAEnB,KAAK,aAAa,EACnB,MAAM,eAAe,CAAC;AACvB,OAAO,KAAK,EACV,eAAe,EACf,YAAY,EACZ,aAAa,EACd,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAEjE,uBAAe,UAAU,CAAC,CAAC,SAAS,EAAE;IACpC,OAAO,CAAC,OAAO,CAAC,CAAS;IACzB,OAAO,CAAC,WAAW,CAAC;IAEpB,SAAS,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACzB,SAAS,CAAC,UAAU,CAAC,EAAE,aAAa,CAAC;IACrC,SAAS,CAAC,WAAW,EAAE,YAAY,GAAG,SAAS,CAAC;IAEhD,SAAS,CAAC,MAAM,EAAE,UAAU,CAAC,OAAO,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;gBAEzC,EAAE,OAAO,EAAE,UAAU,EAAE,EAAE,eAAe;cA6BpC,QAAQ;IASjB,aAAa;IAIpB,SAAS,CAAC,cAAc,CAAC,CAAC,EAAE,CAAC,EAC3B,QAAQ,EAAE,aAAa,CAAC,CAAC,EAAE,CAAC,EAAE,kBAAkB,CAAC,GAChD,iBAAiB,CAAC,CAAC,EAAE,CAAC,CAAC;IA0B1B,SAAS,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,OAAO,GAAG,iBAAiB,CAAC,CAAC,EAAE,CAAC,CAAC;CAGtE;AAED,eAAe,UAAU,CAAC"}

package/dist/client/base-client.js

@@ -0,0 +1,71 @@
+import createClient from "openapi-fetch";
+class BaseClient {
+    baseUrl;
+    initialized;
+    token;
+    getTokenFn;
+    serviceName;
+    client;
+    constructor({ baseUrl, getTokenFn }) {
+        this.initialized = false;
+        if (baseUrl) {
+            this.baseUrl = baseUrl;
+            this.initialized = true;
+        }
+        if (getTokenFn) {
+            this.getTokenFn = getTokenFn;
+        }
+        this.token = undefined;
+        this.client = createClient({ baseUrl: this.baseUrl });
+        const authMiddleware = {
+            onRequest: async ({ request }) => {
+                if (!this.token && this.getTokenFn) {
+                    this.token = await this.getTokenFn(this.serviceName);
+                }
+                if (this.token) {
+                    request.headers.set("Authorization", `Bearer ${this.token}`);
+                }
+                return request;
+            },
+        };
+        this.client.use(authMiddleware);
+    }
+    async getToken() {
+        if (this.getTokenFn) {
+            const token = await this.getTokenFn(this.serviceName);
+            this.token = token;
+        }
+        return this.token;
+    }
+    isInitialized() {
+        return this.initialized;
+    }
+    formatResponse(response) {
+        let outputData = undefined;
+        let outputMetadata = undefined;
+        if (!response) {
+            return {};
+        }
+        if (response.data) {
+            const dataEntries = Object.entries(response.data);
+            // by docs the body should contain a "data"
+            // properties with the response values
+            const containsData = dataEntries.find((x) => x[0] === "data");
+            const containsMetadata = dataEntries.find((x) => x[0] === "metadata");
+            if (containsMetadata) {
+                outputMetadata = containsMetadata[1];
+            }
+            outputData = containsData ? containsData[1] : response.data;
+        }
+        return {
+            data: outputData,
+            metadata: outputMetadata,
+            error: response.error,
+        };
+    }
+    formatError(reason) {
+        return { error: reason };
+    }
+}
+export default BaseClient;
+//# sourceMappingURL=base-client.js.map

package/dist/client/base-client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"base-client.js","sourceRoot":"","sources":["../../src/client/base-client.ts"],"names":[],"mappings":"AAAA,OAAO,YAGN,MAAM,eAAe,CAAC;AAQvB,MAAe,UAAU;IACf,OAAO,CAAU;IACjB,WAAW,CAAC;IAEV,KAAK,CAAU;IACf,UAAU,CAAiB;IAC3B,WAAW,CAA2B;IAEtC,MAAM,CAAqC;IAErD,YAAY,EAAE,OAAO,EAAE,UAAU,EAAmB;QAClD,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC;QACzB,IAAI,OAAO,EAAE,CAAC;YACZ,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;YACvB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;QAC1B,CAAC;QAED,IAAI,UAAU,EAAE,CAAC;YACf,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC/B,CAAC;QAED,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;QACvB,IAAI,CAAC,MAAM,GAAG,YAAY,CAAI,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;QACzD,MAAM,cAAc,GAAe;YACjC,SAAS,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE;gBAC/B,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;oBACnC,IAAI,CAAC,KAAK,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,WAA2B,CAAC,CAAC;gBACvE,CAAC;gBAED,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;oBACf,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,UAAU,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC;gBAC/D,CAAC;gBACD,OAAO,OAAO,CAAC;YACjB,CAAC;SACF,CAAC;QAEF,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;IAClC,CAAC;IAES,KAAK,CAAC,QAAQ;QACtB,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACpB,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,WAA2B,CAAC,CAAC;YACtE,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACrB,CAAC;QAED,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAEM,aAAa;QAClB,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAES,cAAc,CACtB,QAAiD;QAEjD,IAAI,UAAU,GAAG,SAAS,CAAC;QAC3B,IAAI,cAAc,GAAG,SAAS,CAAC;QAC/B,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,OAAO,EAA6B,CAAC;QACvC,CAAC;QACD,IAAI,QAAQ,CAAC,IAAI,EAAE,CAAC;YAClB,MAAM,WAAW,GAAG,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAClD,2CAA2C;YAC3C,sCAAsC;YACtC,MAAM,YAAY,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,CAAC;YAC9D,MAAM,gBAAgB,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,UAAU,CAAC,CAAC;YAEtE,IAAI,gBAAgB,EAAE,CAAC;gBACrB,cAAc,GAAG,gBAAgB,CAAC,CAAC,CAAC,CAAC;YACvC,CAAC;YACD,UAAU,GAAG,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC;QAC9D,CAAC;QAED,OAAO;YACL,IAAI,EAAE,UAAU;YAChB,QAAQ,EAAE,cAAc;YACxB,KAAK,EAAE,QAAQ,CAAC,KAAK;SACgB,CAAC;IAC1C,CAAC;IAES,WAAW,CAAO,MAAe;QACzC,OAAO,EAAE,KAAK,EAAE,MAAM,EAAwC,CAAC;IACjE,CAAC;CACF;AAED,eAAe,UAAU,CAAC"}