@adobe/aio-commerce-lib-auth 0.1.0 → 0.3.0

package/source/lib/integration-auth.ts

@@ -1,95 +0,0 @@
-/*
- * Copyright 2025 Adobe. All rights reserved.
- * This file is licensed to you under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License. You may obtain a copy
- * of the License at http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software distributed under
- * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
- * OF ANY KIND, either express or implied. See the License for the specific language
- * governing permissions and limitations under the License.
- */
-
-import crypto from "node:crypto";
-import OAuth1a from "oauth-1.0a";
-
-import { allNonEmpty } from "./params";
-
-const HTTP_METHODS = ["GET", "POST", "PUT", "PATCH", "DELETE"] as const;
-const INTEGRATION_AUTH_HEADERS = ["Authorization"] as const;
-const INTEGRATION_AUTH_PARAMS = [
-  "AIO_COMMERCE_INTEGRATIONS_CONSUMER_KEY",
-  "AIO_COMMERCE_INTEGRATIONS_CONSUMER_SECRET",
-  "AIO_COMMERCE_INTEGRATIONS_ACCESS_TOKEN",
-  "AIO_COMMERCE_INTEGRATIONS_ACCESS_TOKEN_SECRET",
-] as const;
-
-/** Defines a union of allowed integration authentication parameters. */
-export type IntegrationAuthParam = (typeof INTEGRATION_AUTH_PARAMS)[number];
-
-/** Defines a key-value map of integration authentication parameters. */
-export type IntegrationAuthParams = Partial<
-  Record<IntegrationAuthParam, string>
->;
-
-/** Defines a union of allowed integration authentication headers. */
-export type IntegrationAuthHeader = (typeof INTEGRATION_AUTH_HEADERS)[number];
-
-/** Defines a key-value map of integration authentication headers. */
-export type IntegrationAuthHeaders = Record<IntegrationAuthHeader, string>;
-
-type HttpMethod = (typeof HTTP_METHODS)[number];
-
-/** Defines an authentication provider for integration authentication. */
-export interface IntegrationAuthProvider {
-  getHeaders: (method: HttpMethod, url: string) => IntegrationAuthHeaders;
-}
-
-/**
- * If the required integration parameters are present, this function returns an {@link IntegrationAuthProvider}.
- * @param params includes integration parameters
- */
-export function getIntegrationAuthProvider(params: IntegrationAuthParams) {
-  const config = resolveIntegrationConfig(params);
-
-  if (config) {
-    const oauth = new OAuth1a({
-      consumer: {
-        key: config.consumerKey,
-        secret: config.consumerSecret,
-      },
-      signature_method: "HMAC-SHA256",
-      hash_function: (baseString, key) =>
-        crypto.createHmac("sha256", key).update(baseString).digest("base64"),
-    });
-
-    const oauthToken = {
-      key: config.accessToken,
-      secret: config.accessTokenSecret,
-    };
-
-    return {
-      getHeaders(method: HttpMethod, url: string) {
-        return oauth.toHeader(oauth.authorize({ url, method }, oauthToken));
-      },
-    } satisfies IntegrationAuthProvider;
-  }
-}
-
-function resolveIntegrationConfig(params: IntegrationAuthParams) {
-  if (
-    allNonEmpty(params, [
-      "AIO_COMMERCE_INTEGRATIONS_CONSUMER_KEY",
-      "AIO_COMMERCE_INTEGRATIONS_CONSUMER_SECRET",
-      "AIO_COMMERCE_INTEGRATIONS_ACCESS_TOKEN",
-      "AIO_COMMERCE_INTEGRATIONS_ACCESS_TOKEN_SECRET",
-    ])
-  ) {
-    return {
-      consumerKey: params.AIO_COMMERCE_INTEGRATIONS_CONSUMER_KEY,
-      consumerSecret: params.AIO_COMMERCE_INTEGRATIONS_CONSUMER_SECRET,
-      accessToken: params.AIO_COMMERCE_INTEGRATIONS_ACCESS_TOKEN,
-      accessTokenSecret: params.AIO_COMMERCE_INTEGRATIONS_ACCESS_TOKEN_SECRET,
-    };
-  }
-}

package/source/lib/params.ts

@@ -1,34 +0,0 @@
-/*
- * Copyright 2025 Adobe. All rights reserved.
- * This file is licensed to you under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License. You may obtain a copy
- * of the License at http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software distributed under
- * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
- * OF ANY KIND, either express or implied. See the License for the specific language
- * governing permissions and limitations under the License.
- */
-
-/**
- * Checks if the given value is non-empty.
- *
- * @param name of the parameter. Required because of `aio app dev` compatibility: inputs mapped to undefined env vars come as $<input_name> in dev mode, but as '' in prod mode.
- * @param value of the parameter.
- */
-export function nonEmpty(name: string, value: string | undefined) {
-  const v = value?.trim();
-  return v !== undefined && v !== `$${name}`;
-}
-
-/**
- * Checks if all required parameters are non-empty.
- * @param params action input parameters.
- * @param required list of required parameter names.
- */
-export function allNonEmpty<const T extends string>(
-  params: Record<string, string | undefined>,
-  required: T[],
-): params is Required<Record<T, string> & Record<string, string>> {
-  return required.every((name) => nonEmpty(name, params[name]));
-}

package/test/ims-auth.test.ts

@@ -1,69 +0,0 @@
-/*
- * Copyright 2025 Adobe. All rights reserved.
- * This file is licensed to you under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License. You may obtain a copy
- * of the License at http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software distributed under
- * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
- * OF ANY KIND, either express or implied. See the License for the specific language
- * governing permissions and limitations under the License.
- */
-
-import { getToken } from "@adobe/aio-lib-ims";
-import { describe, expect, test, vi } from "vitest";
-
-import { getImsAuthProvider, type ImsAuthParams } from "~/lib/ims-auth";
-
-vi.mock("@adobe/aio-lib-ims", async () => ({
-  context: (await vi.importActual("@adobe/aio-lib-ims")).context,
-  getToken: vi.fn(),
-}));
-
-describe("getImsAuthProvider", () => {
-  const params: ImsAuthParams = {
-    AIO_COMMERCE_IMS_CLIENT_ID: "test-client-id",
-    AIO_COMMERCE_IMS_CLIENT_SECRETS: JSON.stringify(["supersecret"]),
-    AIO_COMMERCE_IMS_TECHNICAL_ACCOUNT_ID: "test-technical-account-id",
-    AIO_COMMERCE_IMS_TECHNICAL_ACCOUNT_EMAIL: "test-email@example.com",
-    AIO_COMMERCE_IMS_IMS_ORG_ID: "test-org-id",
-    AIO_COMMERCE_IMS_SCOPES: JSON.stringify(["scope1", "scope2"]),
-  };
-
-  test("should export token when all required params are provided", async () => {
-    const authToken = "supersecrettoken";
-    vi.mocked(getToken).mockResolvedValue(authToken);
-
-    const imsProvider = await getImsAuthProvider(params);
-    expect(imsProvider).toBeDefined();
-
-    const retrievedToken = await imsProvider?.getAccessToken();
-    expect(retrievedToken).toEqual(authToken);
-
-    const headers = await imsProvider?.getHeaders();
-    expect(headers).toHaveProperty("Authorization", `Bearer ${authToken}`);
-    expect(headers).toHaveProperty(
-      "x-api-key",
-      params.AIO_COMMERCE_IMS_CLIENT_ID,
-    );
-  });
-
-  for (const param of [
-    "AIO_COMMERCE_IMS_CLIENT_ID",
-    "AIO_COMMERCE_IMS_CLIENT_SECRETS",
-    "AIO_COMMERCE_IMS_TECHNICAL_ACCOUNT_ID",
-    "AIO_COMMERCE_IMS_TECHNICAL_ACCOUNT_EMAIL",
-    "AIO_COMMERCE_IMS_IMS_ORG_ID",
-    "AIO_COMMERCE_IMS_SCOPES",
-  ]) {
-    test(`should return undefined when ${param} is missing`, async () => {
-      const incompleteParams = {
-        ...params,
-        [param]: undefined,
-      };
-
-      const imsProvider = await getImsAuthProvider(incompleteParams);
-      expect(imsProvider).toBeUndefined();
-    });
-  }
-});

package/test/integration-auth.test.ts

@@ -1,61 +0,0 @@
-/*
- * Copyright 2025 Adobe. All rights reserved.
- * This file is licensed to you under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License. You may obtain a copy
- * of the License at http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software distributed under
- * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
- * OF ANY KIND, either express or implied. See the License for the specific language
- * governing permissions and limitations under the License.
- */
-
-import { describe, expect, test } from "vitest";
-import {
-  getIntegrationAuthProvider,
-  type IntegrationAuthParams,
-} from "~/lib/integration-auth";
-
-/** Regex to match the OAuth 1.0a header format. */
-const OAUTH1_REGEX =
-  /^OAuth oauth_consumer_key="[^"]+", oauth_nonce="[^"]+", oauth_signature="[^"]+", oauth_signature_method="HMAC-SHA256", oauth_timestamp="[^"]+", oauth_token="[^"]+", oauth_version="1\.0"$/;
-
-describe("getIntegrationAuthProvider", () => {
-  const params: IntegrationAuthParams = {
-    AIO_COMMERCE_INTEGRATIONS_CONSUMER_KEY: "test-consumer-key",
-    AIO_COMMERCE_INTEGRATIONS_CONSUMER_SECRET: "test-consumer-secret",
-    AIO_COMMERCE_INTEGRATIONS_ACCESS_TOKEN: "test-access-token",
-    AIO_COMMERCE_INTEGRATIONS_ACCESS_TOKEN_SECRET: "test-access-token-secret",
-  };
-
-  test("should export getIntegrationAccessToken", () => {
-    const integrationProvider = getIntegrationAuthProvider(params);
-    expect(integrationProvider).toBeDefined();
-
-    const headers = integrationProvider?.getHeaders(
-      "GET",
-      "http://localhost/test",
-    );
-    expect(headers).toHaveProperty(
-      "Authorization",
-      expect.stringMatching(OAUTH1_REGEX),
-    );
-  });
-
-  for (const param of [
-    "AIO_COMMERCE_INTEGRATIONS_CONSUMER_KEY",
-    "AIO_COMMERCE_INTEGRATIONS_CONSUMER_SECRET",
-    "AIO_COMMERCE_INTEGRATIONS_ACCESS_TOKEN",
-    "AIO_COMMERCE_INTEGRATIONS_ACCESS_TOKEN_SECRET",
-  ]) {
-    test(`should return undefined when ${param} is missing`, () => {
-      const incompleteParams = {
-        ...params,
-        [param]: undefined,
-      };
-
-      const integrationProvider = getIntegrationAuthProvider(incompleteParams);
-      expect(integrationProvider).toBeUndefined();
-    });
-  }
-});

package/tsconfig.json

@@ -1,15 +0,0 @@
-{
-  "extends": "@aio-commerce-sdk/config-typescript/tsconfig.base.json",
-  "compilerOptions": {
-    "baseUrl": ".",
-    "rootDir": ".",
-    "outDir": "./dist",
-
-    "paths": {
-      "~/*": ["./source/*"],
-      "~~/*": ["./*"]
-    }
-  },
-
-  "include": ["tsdown.config.ts", "source/**/*", "test/**/*"]
-}

package/tsdown.config.ts

@@ -1,7 +0,0 @@
-import { baseConfig } from "@aio-commerce-sdk/config-tsdown/tsdown.config.base";
-import { defineConfig } from "tsdown";
-
-export default defineConfig({
-  ...baseConfig,
-  entry: ["./source/index.ts"],
-});

package/vitest.config.ts

@@ -1,16 +0,0 @@
-import { resolve } from "node:path";
-import { defineConfig } from "vitest/config";
-
-export default defineConfig({
-  resolve: {
-    alias: {
-      "~": resolve(__dirname, "./source"),
-      "~~": resolve(__dirname, "./"),
-    },
-  },
-
-  test: {
-    globals: true,
-    environment: "node",
-  },
-});