rebilly-js-sdk 62.129.0 → 62.131.0

package/scripts/type-generation/generate-ts-types.js

@@ -9,6 +9,14 @@ const schemaTypes = {
     REPORTS: 'reports',
 };
 
+// Names emitted by openapi-typescript (after the rename in processSchema)
+// that we re-export from the "rebilly-js-sdk" module.
+const openApiSharedTypeNames = ['operations'];
+const openApiPerSchemaTypeNames = (schemaType) => [
+    `${schemaType}Paths`,
+    `${schemaType}Components`,
+];
+
 // Takes a schema object and returns the new schema with
 // adjusted `paths` properties based on the prefix we should remove.
 // For example, storefront APIs should only include paths with the prefix /storefront
@@ -62,10 +70,20 @@ async function generateTypesFromSchema(schema) {
     const combinedSDKTypes =
         coreTypes.sdkTypes + storefrontTypes.sdkTypes + reportsTypes.sdkTypes;
 
+    const moduleReexports = buildModuleReexports([
+        ...openApiSharedTypeNames,
+        ...openApiPerSchemaTypeNames(schemaTypes.CORE),
+        ...openApiPerSchemaTypeNames(schemaTypes.STOREFRONT),
+        ...openApiPerSchemaTypeNames(schemaTypes.REPORTS),
+        ...coreTypes.sdkTypeNames,
+        ...storefrontTypes.sdkTypeNames,
+        ...reportsTypes.sdkTypeNames,
+    ]);
+
     console.log(
         '🍹 Mixing openapi-typescript types and custom SDK types into the same file (/typings/rebilly/index.d.ts)',
     );
-    mergeTypesIntoTemplate(combinedApiTypes, combinedSDKTypes);
+    mergeTypesIntoTemplate(combinedApiTypes, combinedSDKTypes, moduleReexports);
 }
 
 async function processSchema(openApiSchema, schemaType) {
@@ -86,8 +104,9 @@ async function processSchema(openApiSchema, schemaType) {
     openApiTypes = fixSpecialTypes(openApiTypes);
 
     // Generating custom SDK types with custom rebilly script
-    const sdkTypes = generateSdkTypes(openApiSchema);
-    return { openApiTypes, sdkTypes };
+    const { types: sdkTypes, names: sdkTypeNames } =
+        generateSdkTypes(openApiSchema);
+    return { openApiTypes, sdkTypes, sdkTypeNames };
 }
 
 function fixProperties(openApiSchema) {
@@ -126,11 +145,29 @@ function createTemporaryTypingsDirectory() {
     }
 }
 
-function mergeTypesIntoTemplate(openApiTypes, sdkTypes) {
+// Builds the body of the `declare module "rebilly-js-sdk"` block:
+// one `export type X = rebilly.X` alias per name, deduplicated.
+function buildModuleReexports(names) {
+    const seen = new Set();
+    return names
+        .filter((name) => {
+            if (seen.has(name)) return false;
+            seen.add(name);
+            return true;
+        })
+        .map((name) => `export type ${name} = rebilly.${name};`)
+        .join('\n    ');
+}
+
+function mergeTypesIntoTemplate(openApiTypes, sdkTypes, moduleReexports) {
     const templateFilename = './types-generation/template.d.ts';
     let templateData = readFileSync(templateFilename, 'utf-8');
     templateData = templateData.replaceAll('//<open-api-types>', openApiTypes);
     templateData = templateData.replaceAll('//<sdk-types>', sdkTypes);
+    templateData = templateData.replaceAll(
+        '//<module-reexports>',
+        moduleReexports,
+    );
 
     createTemporaryTypingsDirectory();
 

package/types-generation/template.d.ts

@@ -1,3 +1,8 @@
+/**
+ * @deprecated Import types from `"rebilly-js-sdk"` directly instead of accessing them via the `rebilly` global namespace.
+ * Example: `import type { GetCustomerCollectionRequest } from "rebilly-js-sdk"`.
+ * The `rebilly` global namespace is kept for backwards compatibility and will be removed in a future major version.
+ */
 declare namespace rebilly {
     type Expandable<T> = Partial<T> & { expand?: string };
 
@@ -8,6 +13,12 @@ declare namespace rebilly {
     //<open-api-types>
 }
 
+declare module "rebilly-js-sdk" {
+    export type Expandable<T> = rebilly.Expandable<T>;
+
+    //<module-reexports>
+}
+
 declare module "rebilly-js-sdk/types" {
     export = rebilly;
 }