@stripe/extensibility-dev-tools 0.24.2 → 0.25.1

package/dist/bin/create-upload-image.cjs

@@ -28,6 +28,7 @@ var import_node_child_process2 = require("child_process");
 var fs3 = __toESM(require("fs"), 1);
 var os2 = __toESM(require("os"), 1);
 var path3 = __toESM(require("path"), 1);
+var import_extensibility_tool_utils7 = require("@stripe/extensibility-tool-utils");
 
 // src/custom-objects/build-definitions.ts
 var fs2 = __toESM(require("fs"), 1);
@@ -391,35 +392,35 @@ export default class MyBalanceApp implements Billing.CustomerBalanceApplication<
 `
   },
   {
-    path: "extensions/billing.invoice_collection_setting/index.test.ts",
+    path: "extensions/billing.invoice_collection_options/index.test.ts",
     content: `import { beforeEach, describe, it, expect } from 'vitest';
 
-import MyInvoiceCollectionSetting from './index.js';
+import MyInvoiceCollectionOptions from './index.js';
 
-describe('MyInvoiceCollectionSetting', () => {
-  let instance: MyInvoiceCollectionSetting;
+describe('MyInvoiceCollectionOptions', () => {
+  let instance: MyInvoiceCollectionOptions;
 
   beforeEach(() => {
-    instance = new MyInvoiceCollectionSetting();
+    instance = new MyInvoiceCollectionOptions();
   });
 
   it('should be constructable', () => {
-    expect(instance).toBeInstanceOf(MyInvoiceCollectionSetting);
+    expect(instance).toBeInstanceOf(MyInvoiceCollectionOptions);
   });
 });
 `
   },
   {
-    path: "extensions/billing.invoice_collection_setting/index.ts",
+    path: "extensions/billing.invoice_collection_options/index.ts",
     content: `import type { Billing, Context } from '@stripe/extensibility-sdk';
 
 // eslint-disable-next-line @typescript-eslint/no-empty-object-type
-interface MyInvoiceCollectionSettingConfig {}
+interface MyInvoiceCollectionOptionsConfig {}
 
-export default class MyInvoiceCollectionSetting implements Billing.InvoiceCollectionSetting<MyInvoiceCollectionSettingConfig> {
-  collectionOverride(
-    _request: Billing.InvoiceCollectionSetting.InvoiceCollectionRequest,
-    _config: MyInvoiceCollectionSettingConfig,
+export default class MyInvoiceCollectionOptions implements Billing.InvoiceCollectionOptions<MyInvoiceCollectionOptionsConfig> {
+  overrideOptions(
+    _request: Billing.InvoiceCollectionOptions.InvoiceCollectionOptionsInput,
+    _config: MyInvoiceCollectionOptionsConfig,
     _context: Context
   ) {
     // TODO: implement your collection setting logic here
@@ -891,6 +892,99 @@ install-deps.log
 
 # generated schemas
 generated
+`
+  },
+  {
+    path: "root/custom-objects/eslint.config.mts",
+    content: `import eslint from '@eslint/js';
+import { defineConfig } from 'eslint/config';
+import tseslint from 'typescript-eslint';
+import eslintConfigPrettier from 'eslint-config-prettier/flat';
+
+import globals from 'globals';
+
+import stripeAppsConfig from '@stripe/extensibility-eslint-plugin';
+import customObjectsConfig from '@stripe/extensibility-eslint-plugin/custom-objects';
+
+export default defineConfig([
+  eslint.configs.recommended,
+  ...tseslint.configs.recommended,
+  ...stripeAppsConfig,
+  ...customObjectsConfig,
+
+  // Global ignores
+  {
+    ignores: ['dist', 'generated', 'node_modules'],
+  },
+
+  // TypeScript source files (with type-checking)
+  {
+    name: 'sources',
+    files: ['src/**/*.ts'],
+    ignores: ['**/*.test.ts', '**/__tests__/**'],
+    languageOptions: {
+      globals: {
+        ...globals.node,
+      },
+      parserOptions: {
+        projectService: true,
+        tsconfigRootDir: import.meta.dirname,
+      },
+    },
+  },
+
+  // Test files
+  {
+    name: 'tests',
+    files: ['src/**/*.test.ts', 'src/**/__tests__/**/*.ts'],
+    languageOptions: {
+      globals: {
+        ...globals.node,
+      },
+      parserOptions: {
+        projectService: true,
+        tsconfigRootDir: import.meta.dirname,
+      },
+    },
+  },
+
+  // Config files
+  {
+    name: 'ts-configs',
+    files: ['*.config.m?ts', 'eslint.config.mts'],
+    languageOptions: {
+      globals: {
+        ...globals.node,
+      },
+      parserOptions: {
+        projectService: false,
+      },
+    },
+    rules: {
+      '@typescript-eslint/no-unused-vars': 'off',
+    },
+  },
+
+  // JavaScript/MJS files (scripts, configs) \u2014 no TS project, so only
+  // disable the TS-parser-specific rule that doesn't apply without it.
+  {
+    name: 'js-configs',
+    files: ['**/*.js', '**/*.mjs'],
+    languageOptions: {
+      globals: {
+        ...globals.node,
+      },
+      parserOptions: {
+        projectService: false,
+      },
+    },
+    rules: {
+      '@typescript-eslint/no-require-imports': 'off',
+    },
+  },
+
+  eslintConfigPrettier,
+]);
 `
   },
   {
@@ -903,7 +997,9 @@ generated
   "private": true,
   "scripts": {
     "build": "test -d src && custom-objects-build --input src --output dist || true",
+    "lint": "pnpm lint:types && pnpm lint:eslint",
     "lint:types": "test ! -d src || tsc --noEmit",
+    "lint:eslint": "eslint .",
     "test": "vitest run"
   },
   "dependencies": {
@@ -926,8 +1022,20 @@ generated
     "moduleResolution": "bundler",
     "types": ["vitest/globals"]
   },
+  "include": ["src/**/*.ts"],
   "exclude": ["dist"]
 }
+`
+  },
+  {
+    path: "root/custom-objects/vitest.config.mts",
+    content: `import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+  test: {
+    globals: true,
+  },
+});
 `
   },
   {
@@ -1045,7 +1153,7 @@ export default defineConfig([
     "build": "pnpm -r --if-present build",
     "lint": "pnpm lint:types && pnpm lint:eslint && pnpm lint:format",
     "lint:types": "pnpm -r --if-present lint:types",
-    "lint:eslint": "eslint . --ignore-pattern 'extensions/**' && pnpm -r --filter './extensions/*' --if-present lint:eslint",
+    "lint:eslint": "eslint . --ignore-pattern 'extensions/**' && pnpm -r --filter './extensions/*' --if-present lint:eslint && pnpm -r --filter './custom-objects' --if-present lint:eslint",
     "lint:format": "prettier --check .",
     "fix:lint": "eslint --fix . --ignore-pattern 'extensions/**' && pnpm -r --filter './extensions/*' --if-present fix:lint",
     "fix:format": "prettier --write .",
@@ -1091,7 +1199,7 @@ declarations:
     content: `#!/usr/bin/env tsx
 /**
  * Runs tests across the workspace:
- * - vitest for script extensions and custom objects (extensions/*)
+ * - vitest for script extensions (extensions/*) and custom objects (custom-objects/)
  * - jest for UI extensions (ui/)
  */
 import { existsSync, readdirSync } from 'node:fs';
@@ -1101,6 +1209,8 @@ const hasExtensions =
   existsSync('extensions') &&
   readdirSync('extensions').some((name) => existsSync(\`extensions/\${name}/package.json\`));
 
+const hasCustomObjects = existsSync('custom-objects/package.json');
+
 const hasUI = existsSync('ui/package.json');
 
 let exitCode = 0;
@@ -1113,7 +1223,7 @@ function run(cmd: string): void {
   }
 }
 
-if (hasExtensions) {
+if (hasExtensions || hasCustomObjects) {
   run('vitest run');
 }
 
@@ -1265,11 +1375,33 @@ function _devNpmDep(name, version) {
   return { type: "dev-npm", name, version };
 }
 
+// src/workspace-versions.json
+var workspace_versions_default = {
+  "@stripe/extensibility-custom-objects": "0.8.0",
+  "@stripe/extensibility-custom-objects-tools": "0.42.1",
+  "@stripe/extensibility-dev-tools": "0.25.1",
+  "@stripe/extensibility-eslint-plugin": "0.17.1",
+  "@stripe/extensibility-language-server": "0.3.4",
+  "@stripe/extensibility-sdk": "0.27.1",
+  "@stripe/extensibility-test-helpers": "0.2.7"
+};
+
+// src/workspace-versions.ts
+var _workspaceVersions = workspace_versions_default;
+function _workspaceVersion(packageName) {
+  const v = _workspaceVersions[packageName];
+  if (v === void 0) {
+    throw new Error(
+      `Unknown workspace package "${packageName}". Check workspace-versions.json or run: tsx scripts/src/sync-workspace-versions.ts`
+    );
+  }
+  return v;
+}
+
 // src/templates/extensions/base.ts
-var import_extensibility_tool_utils6 = require("@stripe/extensibility-tool-utils");
 var SDK_PACKAGE_NAME = "@stripe/extensibility-sdk";
 var LANGUAGE_SERVER_PACKAGE_NAME = "@stripe/extensibility-language-server";
-var LANGUAGE_SERVER_PACKAGE_VERSION = `^${(0, import_extensibility_tool_utils6._workspaceVersion)(LANGUAGE_SERVER_PACKAGE_NAME)}`;
+var LANGUAGE_SERVER_PACKAGE_VERSION = `^${_workspaceVersion(LANGUAGE_SERVER_PACKAGE_NAME)}`;
 function _createExtensionEslintConfigFile(params, context) {
   const { id, extensionInterfaceId } = params;
   const { fs: fs4 } = context;
@@ -1312,7 +1444,7 @@ function _createBaseOutput(params, context) {
     dependencies: {
       // Exact pin (no caret) — the SDK is tightly coupled to dev-tools and
       // must match the version that generated the extension scaffolding.
-      runtime: [_npmDep(SDK_PACKAGE_NAME, (0, import_extensibility_tool_utils6._workspaceVersion)(SDK_PACKAGE_NAME))],
+      runtime: [_npmDep(SDK_PACKAGE_NAME, _workspaceVersion(SDK_PACKAGE_NAME))],
       dev: [_devNpmDep(LANGUAGE_SERVER_PACKAGE_NAME, LANGUAGE_SERVER_PACKAGE_VERSION)]
     },
     postGenerationHooks: [
@@ -1571,14 +1703,14 @@ var billing_bill_discount_calculation_default = {
   [EXTENSION_INTERFACE_ID5]: discountCalculationTemplate
 };
 
-// src/templates/extensions/billing.invoice_collection_setting.ts
-var EXTENSION_INTERFACE_ID6 = "billing.invoice_collection_setting";
-var invoiceCollectionSettingTemplate = {
+// src/templates/extensions/billing.invoice_collection_options.ts
+var EXTENSION_INTERFACE_ID6 = "billing.invoice_collection_options";
+var invoiceCollectionOptionsTemplate = {
   hidden: true,
   methods: {
-    collection_override: { implementation_types: ["script"] }
+    override_options: { implementation_types: ["script"] }
   },
-  description: "Use Stripe Scripts to create custom invoice collection logic that controls how your integration handles invoices generated from subscriptions.",
+  description: "Use Stripe Scripts to create custom invoice collection options that controls how your integration handles invoices generated from subscriptions.",
   generate: (params, context) => {
     const { id } = params;
     const { fs: fs4 } = context;
@@ -1606,15 +1738,15 @@ var invoiceCollectionSettingTemplate = {
         ...base.files
       ],
       methods: {
-        collection_override: {
+        override_options: {
           implementation_type: "script"
         }
       }
     };
   }
 };
-var billing_invoice_collection_setting_default = {
-  [EXTENSION_INTERFACE_ID6]: invoiceCollectionSettingTemplate
+var billing_invoice_collection_options_default = {
+  [EXTENSION_INTERFACE_ID6]: invoiceCollectionOptionsTemplate
 };
 
 // src/templates/extensions/billing.prorations.ts
@@ -1722,7 +1854,7 @@ var DEFAULT_TEMPLATES = {
   ...extend_workflows_custom_action_default,
   ...billing_customer_balance_application_default,
   ...billing_bill_discount_calculation_default,
-  ...billing_invoice_collection_setting_default,
+  ...billing_invoice_collection_options_default,
   ...billing_prorations_default,
   ...billing_recurring_billing_item_handling_default
 };
@@ -1788,10 +1920,11 @@ function mapActions(actions) {
 }
 function mapProperties(schema) {
   const result = {};
-  const requiredSet = new Set(schema?.required ?? []);
-  if (!schema?.properties) return result;
-  const defs = schema.$defs ?? {};
-  for (const [key, propSchema] of Object.entries(schema.properties)) {
+  const resolvedSchema = schema === null || schema === void 0 ? schema : resolveRef(schema, schema.$defs ?? {});
+  const requiredSet = new Set(resolvedSchema?.required ?? []);
+  if (!resolvedSchema?.properties) return result;
+  const defs = resolvedSchema.$defs ?? {};
+  for (const [key, propSchema] of Object.entries(resolvedSchema.properties)) {
     result[key] = toFieldSchema(resolveRef(propSchema, defs), requiredSet.has(key));
   }
   return result;
@@ -1835,10 +1968,11 @@ function toFieldSchema(schema, required) {
     fieldSchema.valuesPresence = FieldPresence.PRESENT;
   }
   if (schema.default !== void 0) {
-    if (dataType === DataType.ENUM_TYPE && enumValues && (typeof schema.default !== "string" || !enumValues.includes(schema.default))) {
-      throw new Error(
-        `Default value ${JSON.stringify(schema.default)} is not a valid enum value. Expected one of: ${enumValues.join(", ")}`
-      );
+    if (dataType === DataType.ENUM_TYPE && enumValues) {
+      validateEnumDefault(schema.default, enumValues);
+    }
+    if (dataType === DataType.DATETIME_TYPE) {
+      validateDatetimeDefault(schema.default);
     }
     fieldSchema.default = toDefaultValue(schema.default, dataType);
   }
@@ -1852,7 +1986,6 @@ function resolveDataType(schema, enumValues, refTarget) {
       if (schema.format === "date-time") return DataType.DATETIME_TYPE;
       return DataType.STRING_TYPE;
     case "integer":
-    case "number":
       return DataType.INTEGER_TYPE;
     case "boolean":
       return DataType.BOOLEAN_TYPE;
@@ -1889,14 +2022,31 @@ function extractSingleLiteral(schema) {
   return null;
 }
 function extractEnumValues(schema) {
-  if (schema.enum) {
+  if (Array.isArray(schema.enum) && schema.enum.every((value) => typeof value === "string")) {
     return schema.enum.map(String);
   }
-  if (Array.isArray(schema.oneOf) && schema.oneOf.length > 0 && schema.oneOf.every((item) => "const" in item)) {
+  if (Array.isArray(schema.oneOf) && schema.oneOf.length > 0 && schema.oneOf.every(
+    (item) => "const" in item && typeof item.const === "string"
+  )) {
     return schema.oneOf.map((item) => String(item.const));
   }
   return null;
 }
+function validateEnumDefault(value, enumValues) {
+  if (typeof value !== "string" || !enumValues.includes(value)) {
+    throw new Error(
+      `Default value ${JSON.stringify(value)} is not a valid enum value. Expected one of: ${enumValues.join(", ")}`
+    );
+  }
+}
+var DATETIME_UTC_MS_RE = /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}(Z|\+00:00)$/;
+function validateDatetimeDefault(value) {
+  if (typeof value !== "string" || !DATETIME_UTC_MS_RE.test(value)) {
+    throw new Error(
+      `Default value ${JSON.stringify(value)} is not a valid ISO 8601 UTC datetime with millisecond precision. Expected format: YYYY-MM-DDTHH:mm:ss.sssZ or YYYY-MM-DDTHH:mm:ss.sss+00:00`
+    );
+  }
+}
 function toValueBoundary(value) {
   if (!Number.isInteger(value)) {
     throw new Error(
@@ -1912,7 +2062,15 @@ function toDefaultValue(value, dataType) {
   if (dataType === DataType.ENUM_TYPE && typeof value === "string") {
     return { stringDefault: value };
   }
+  if (dataType === DataType.DATETIME_TYPE && typeof value === "string") {
+    return { stringDefault: value };
+  }
   if (dataType === DataType.INTEGER_TYPE && typeof value === "number") {
+    if (!Number.isInteger(value)) {
+      throw new Error(
+        `Integer default values must be whole numbers, got ${JSON.stringify(value)}.`
+      );
+    }
     return { integerDefault: value };
   }
   if (dataType === DataType.BOOLEAN_TYPE && typeof value === "boolean") {
@@ -1922,9 +2080,9 @@ function toDefaultValue(value, dataType) {
 }
 
 // src/custom-objects/build-definitions.ts
-var import_extensibility_tool_utils7 = require("@stripe/extensibility-tool-utils");
+var import_extensibility_tool_utils6 = require("@stripe/extensibility-tool-utils");
 async function analyzeAndInjectManifest(options) {
-  const context = options.context ?? (0, import_extensibility_tool_utils7._createCliContext)();
+  const context = options.context ?? (0, import_extensibility_tool_utils6._createCliContext)();
   const manifestPath = options.manifestPath ?? "stripe-app.yaml";
   const projectRoot = options.projectRoot ?? path2.dirname(path2.resolve(manifestPath));
   const resolvedManifestPath = path2.resolve(manifestPath);
@@ -1948,7 +2106,7 @@ async function analyzeAndInjectManifest(options) {
     (diagnostic) => diagnostic.severity === "error"
   );
   if (errorDiagnostics.length > 0) {
-    const details = errorDiagnostics.map((diagnostic) => diagnostic.message).join("; ");
+    const details = errorDiagnostics.map((diagnostic) => diagnostic.message).join("\n");
     throw new Error(details);
   }
   const coPackageJsonPath = path2.join(projectRoot, "custom-objects", "package.json");
@@ -2009,7 +2167,7 @@ async function analyzeAndInjectManifest(options) {
   };
 }
 async function writeCustomObjectArtifacts(options, state) {
-  const context = options.context ?? (0, import_extensibility_tool_utils7._createCliContext)();
+  const context = options.context ?? (0, import_extensibility_tool_utils6._createCliContext)();
   const targetPath = path2.resolve(options.targetPath);
   const { packageBuild, customObjects, coVersion, coDependencies, projectRoot } = state;
   for (const obj of customObjects) {
@@ -2085,16 +2243,18 @@ function readPackageDependencies(packageJsonPath) {
 }
 
 // src/bin/create-upload-image.ts
+var logger = (0, import_extensibility_tool_utils7._createLogger)({ name: "create-upload-image" });
 async function main() {
+  const ctx = (0, import_extensibility_tool_utils7._createCliContext)();
   const targetPath = process.argv[2];
   if (!targetPath) {
-    console.error("Usage: create-upload-image <target-path>");
+    ctx.ux.error("Usage: create-upload-image <target-path>");
     process.exit(1);
   }
   let state = null;
   const manifestPath = "stripe-app.yaml";
   if (fs3.existsSync(manifestPath)) {
-    state = await analyzeAndInjectManifest({ manifestPath });
+    state = await analyzeAndInjectManifest({ manifestPath, context: ctx });
   }
   fs3.mkdirSync(targetPath, { recursive: true });
   const tarball = path3.join(os2.tmpdir(), `upload-image-${String(Date.now())}.tgz`);
@@ -2127,7 +2287,7 @@ async function main() {
     }
   }
   if (state) {
-    await writeCustomObjectArtifacts({ targetPath }, state);
+    await writeCustomObjectArtifacts({ targetPath, context: ctx }, state);
   }
   const imageMetadata = JSON.stringify(
     { image: { version: "1.0", built: (/* @__PURE__ */ new Date()).toISOString() } },
@@ -2137,6 +2297,6 @@ async function main() {
   fs3.writeFileSync(path3.join(targetPath, ".image.json"), imageMetadata + "\n");
 }
 main().catch((err) => {
-  console.error(err);
+  logger.error({ err }, "Unexpected error");
   process.exit(1);
 });