@stripe/extensibility-dev-tools 0.24.2 → 0.25.1

package/dist/bin/gen-workspace.cjs

@@ -26,7 +26,7 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 // src/bin/gen-workspace.ts
 var import_yargs = __toESM(require("yargs"), 1);
 var import_helpers = require("yargs/helpers");
-var import_extensibility_tool_utils12 = require("@stripe/extensibility-tool-utils");
+var import_extensibility_tool_utils10 = require("@stripe/extensibility-tool-utils");
 
 // src/workspace/index.ts
 var import_zod = require("zod");
@@ -586,7 +586,7 @@ var _DependencyManager = class {
 
 // src/workspace/index.ts
 var import_internal = require("@stripe/extensibility-custom-objects-tools/internal");
-var import_extensibility_tool_utils11 = require("@stripe/extensibility-tool-utils");
+var import_extensibility_tool_utils9 = require("@stripe/extensibility-tool-utils");
 
 // src/manifest/stripe-app-manifest.ts
 var import_extensibility_tool_utils3 = require("@stripe/extensibility-tool-utils");
@@ -1247,35 +1247,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
@@ -1747,6 +1747,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,
+]);
 `
   },
   {
@@ -1759,7 +1852,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": {
@@ -1782,8 +1877,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,
+  },
+});
 `
   },
   {
@@ -1901,7 +2008,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 .",
@@ -1947,7 +2054,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';
@@ -1957,6 +2064,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;
@@ -1969,7 +2078,7 @@ function run(cmd: string): void {
   }
 }
 
-if (hasExtensions) {
+if (hasExtensions || hasCustomObjects) {
   run('vitest run');
 }
 
@@ -2733,11 +2842,33 @@ var _ExtensionTemplateManager = class extends import_extensibility_tool_utils4._
   }
 };
 
+// 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_utils9 = 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_utils9._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: fs2 } = context;
@@ -2780,7 +2911,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_utils9._workspaceVersion)(SDK_PACKAGE_NAME))],
+      runtime: [_npmDep(SDK_PACKAGE_NAME, _workspaceVersion(SDK_PACKAGE_NAME))],
       dev: [_devNpmDep(LANGUAGE_SERVER_PACKAGE_NAME, LANGUAGE_SERVER_PACKAGE_VERSION)]
     },
     postGenerationHooks: [
@@ -3039,14 +3170,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: fs2 } = context;
@@ -3074,15 +3205,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
@@ -3190,7 +3321,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
 };
@@ -3203,9 +3334,8 @@ var _templateManager = new _ExtensionTemplateManager(
 );
 
 // src/templates/root/index.ts
-var import_extensibility_tool_utils10 = require("@stripe/extensibility-tool-utils");
 var EXTENSIBILITY_ESLINT_PLUGIN_PACKAGE_NAME = "@stripe/extensibility-eslint-plugin";
-var EXTENSIBILITY_ESLINT_PLUGIN_VERSION = `^${(0, import_extensibility_tool_utils10._workspaceVersion)(EXTENSIBILITY_ESLINT_PLUGIN_PACKAGE_NAME)}`;
+var EXTENSIBILITY_ESLINT_PLUGIN_VERSION = `^${_workspaceVersion(EXTENSIBILITY_ESLINT_PLUGIN_PACKAGE_NAME)}`;
 var _rootWorkspaceTemplate = {
   generate: (params, context) => {
     const { fs: fs2 } = context;
@@ -3260,14 +3390,14 @@ var _rootWorkspaceTemplate = {
           path: "custom-objects/package.json",
           content: fs2.mustache(
             {
-              customObjectsVersion: (0, import_extensibility_tool_utils10._workspaceVersion)(
+              customObjectsVersion: _workspaceVersion(
                 "@stripe/extensibility-custom-objects"
               ),
-              sdkVersion: (0, import_extensibility_tool_utils10._workspaceVersion)("@stripe/extensibility-sdk"),
-              customObjectsToolsVersion: (0, import_extensibility_tool_utils10._workspaceVersion)(
+              sdkVersion: _workspaceVersion("@stripe/extensibility-sdk"),
+              customObjectsToolsVersion: _workspaceVersion(
                 "@stripe/extensibility-custom-objects-tools"
               ),
-              testHelpersVersion: (0, import_extensibility_tool_utils10._workspaceVersion)("@stripe/extensibility-test-helpers")
+              testHelpersVersion: _workspaceVersion("@stripe/extensibility-test-helpers")
             },
             "custom-objects",
             "package.json.mustache"
@@ -3279,6 +3409,16 @@ var _rootWorkspaceTemplate = {
           content: fs2.textFile("custom-objects/tsconfig.json"),
           precious: true
         },
+        {
+          path: "custom-objects/eslint.config.mts",
+          content: fs2.textFile("custom-objects/eslint.config.mts"),
+          precious: true
+        },
+        {
+          path: "custom-objects/vitest.config.mts",
+          content: fs2.textFile("custom-objects/vitest.config.mts"),
+          precious: true
+        },
         {
           path: "ui/package.json",
           content: fs2.textFile("ui/package.json"),
@@ -3305,7 +3445,7 @@ var _rootWorkspaceTemplate = {
           _devNpmDep("@types/node", "^20.19.0"),
           _devNpmDep(
             "@stripe/extensibility-dev-tools",
-            `^${(0, import_extensibility_tool_utils10._workspaceVersion)("@stripe/extensibility-dev-tools")}`
+            `^${_workspaceVersion("@stripe/extensibility-dev-tools")}`
           ),
           _devNpmDep("concurrently", "^9.2.1"),
           _devNpmDep("eslint", "^9.0.0"),
@@ -3399,7 +3539,7 @@ async function _resolvePackageMetadata(providedId, providedName, packageDir) {
   name ??= id;
   return { id, name, version };
 }
-function runPostGenerationHooks(hooks, workingDir, disabled = false, context = (0, import_extensibility_tool_utils11._createCliContext)()) {
+function runPostGenerationHooks(hooks, workingDir, disabled = false, context = (0, import_extensibility_tool_utils9._createCliContext)()) {
   if (!hooks || hooks.length === 0 || disabled) {
     return Promise.resolve();
   }
@@ -3503,9 +3643,9 @@ function resolveMode(options, projectRoot, packageDir) {
       workspaceDir: () => packageDir ?? import_node_path3.default.join(projectRoot, "custom-objects"),
       generate: async (svc) => {
         const customObjectsWorkspaceDir = packageDir ?? import_node_path3.default.join(projectRoot, "custom-objects");
-        const workspaceExists = (0, import_node_fs2.existsSync)(import_node_path3.default.join(customObjectsWorkspaceDir, "package.json")) && (0, import_node_fs2.existsSync)(import_node_path3.default.join(customObjectsWorkspaceDir, "tsconfig.json"));
+        const workspaceScaffoldingExists = (0, import_node_fs2.existsSync)(import_node_path3.default.join(customObjectsWorkspaceDir, "package.json")) && (0, import_node_fs2.existsSync)(import_node_path3.default.join(customObjectsWorkspaceDir, "tsconfig.json")) && (0, import_node_fs2.existsSync)(import_node_path3.default.join(customObjectsWorkspaceDir, "eslint.config.mts"));
         const objectResult = await svc.generateCustomObject({ name: objectName });
-        if (workspaceExists) {
+        if (workspaceScaffoldingExists) {
           return objectResult;
         }
         const workspaceResult = await svc.generateCustomObjectsWorkspace({});
@@ -3520,11 +3660,11 @@ function resolveMode(options, projectRoot, packageDir) {
       finalize: async (_svc, _meta, root, _output, context) => {
         context.ux.log("\nUpdating stripe-app.yaml...");
         const manifestPath = import_node_path3.default.join(root, "stripe-app.yaml");
-        const manifest = await (0, import_extensibility_tool_utils11._openStripeAppManifest)(manifestPath);
-        const apiName = (0, import_extensibility_tool_utils11._toSnakeCase)(objectName);
+        const manifest = await (0, import_extensibility_tool_utils9._openStripeAppManifest)(manifestPath);
+        const apiName = (0, import_extensibility_tool_utils9._toSnakeCase)(objectName);
         if (!manifest.hasCustomObject(apiName)) {
           manifest.addCustomObject(apiName, `custom-objects/src/${apiName}.object.ts`);
-          const tx = (0, import_extensibility_tool_utils11._beginTransaction)();
+          const tx = (0, import_extensibility_tool_utils9._beginTransaction)();
           tx.adopt(manifest);
           const report = await tx.commit();
           if (report.written.length > 0) {
@@ -3618,7 +3758,7 @@ var _defaultServices = {
     };
   },
   generateCustomObjectsWorkspace: async (vars) => {
-    const runner = new import_extensibility_tool_utils11._GeneratorRunner(import_internal._customObjectsWorkspaceGenerator);
+    const runner = new import_extensibility_tool_utils9._GeneratorRunner(import_internal._customObjectsWorkspaceGenerator);
     const plan = await runner.plan(vars, {
       scope: "project",
       projectRoot: process.cwd()
@@ -3632,7 +3772,7 @@ var _defaultServices = {
   loadManifest: (manifestPath) => _StripeAppManifest.load(manifestPath),
   runHooks: runPostGenerationHooks
 };
-async function _regenAppProjectWorkspace(options, services = _defaultServices, context = (0, import_extensibility_tool_utils11._createCliContext)()) {
+async function _regenAppProjectWorkspace(options, services = _defaultServices, context = (0, import_extensibility_tool_utils9._createCliContext)()) {
   const isCustomObjectMode = options.templateId === "custom-object";
   if (!isCustomObjectMode && !options.packageDir && !options.workspaceId) {
     throw new Error("At least one of packageDir or workspaceId is required");
@@ -3753,7 +3893,7 @@ async function _regenAppProjectWorkspace(options, services = _defaultServices, c
 }
 
 // src/bin/gen-workspace.ts
-var logger3 = (0, import_extensibility_tool_utils12._createLogger)({ name: "gen-workspace" });
+var logger3 = (0, import_extensibility_tool_utils10._createLogger)({ name: "gen-workspace" });
 async function main() {
   await (0, import_yargs.default)((0, import_helpers.hideBin)(process.argv)).usage("Regenerate extension or root workspace files from templates").help().version(false).command(
     "$0",
@@ -3816,7 +3956,7 @@ async function main() {
       "Generate a new custom object definition and test"
     ),
     async (args) => {
-      const ctx = (0, import_extensibility_tool_utils12._createCliContext)();
+      const ctx = (0, import_extensibility_tool_utils10._createCliContext)();
       const {
         root,
         templateId,
@@ -3848,7 +3988,7 @@ async function main() {
         void 0,
         ctx
       );
-      (0, import_extensibility_tool_utils12._writeJsonOutput)(outputPath, { success: true });
+      (0, import_extensibility_tool_utils10._writeJsonOutput)(outputPath, { success: true });
     }
   ).parse();
 }