@stripe/extensibility-dev-tools 0.23.5

package/package.json

@@ -0,0 +1,137 @@
+{
+  "name": "@stripe/extensibility-dev-tools",
+  "version": "0.23.5",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/stripe/extensibility-sdk.git"
+  },
+  "author": "Stripe",
+  "type": "module",
+  "main": "./dist/index.js",
+  "bin": {
+    "build-custom-object-definitions": "./dist/bin/build-custom-object-definitions.cjs",
+    "create-upload-image": "./dist/bin/create-upload-image.cjs",
+    "dev-tools-rpc": "./dist/bin/dev-tools-rpc.js",
+    "gen-schemas": "./dist/bin/gen-schemas.js",
+    "gen-workspace": "./dist/bin/gen-workspace.js",
+    "manifest": "./dist/bin/manifest.js",
+    "template-info": "./dist/bin/template-info.js"
+  },
+  "types": "./dist/extensibility-dev-tools-public.d.ts",
+  "files": [
+    "dist",
+    "templates"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/extensibility-dev-tools-public.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    },
+    "./templates": {
+      "types": "./dist/templates/index.d.ts",
+      "import": "./dist/templates/index.js",
+      "require": "./dist/templates/index.cjs"
+    },
+    "./dependencies": {
+      "types": "./dist/dependencies/index.d.ts",
+      "import": "./dist/dependencies/index.js",
+      "require": "./dist/dependencies/index.cjs"
+    },
+    "./manifest": {
+      "types": "./dist/manifest/index.d.ts",
+      "import": "./dist/manifest/index.js",
+      "require": "./dist/manifest/index.cjs"
+    },
+    "./workspace": {
+      "types": "./dist/workspace/index.d.ts",
+      "import": "./dist/workspace/index.js",
+      "require": "./dist/workspace/index.cjs"
+    },
+    "./jsonschema-tools": {
+      "types": "./dist/jsonschema-tools.d.ts",
+      "import": "./dist/jsonschema-tools.js",
+      "require": "./dist/jsonschema-tools.cjs"
+    },
+    "./schemas": {
+      "types": "./dist/schemas/index.d.ts",
+      "import": "./dist/schemas/index.js",
+      "require": "./dist/schemas/index.cjs"
+    }
+  },
+  "dependencies": {
+    "@formspec/build": "0.1.0-alpha.59",
+    "@formspec/core": "0.1.0-alpha.59",
+    "@npmcli/package-json": "^7.0.4",
+    "diff": "^8.0.3",
+    "js-toml": "^1.0.2",
+    "mustache": "^4.2.0",
+    "semver": "^7.7.4",
+    "string-width": "^7.2.0",
+    "yaml": "^2.8.3",
+    "yargs": "^17.7.2",
+    "zod": "^4.3.6",
+    "@stripe/extensibility-custom-objects-tools": "0.40.0",
+    "@stripe/extensibility-tool-utils": "0.6.4"
+  },
+  "devDependencies": {
+    "@protobuf-ts/protoc": "^2.8.2",
+    "@types/mustache": "^4.2.0",
+    "@types/npmcli__package-json": "^4.0.4",
+    "@types/semver": "^7.7.1",
+    "@types/yargs": "^17.0.35",
+    "ts-proto": "^2.11.2",
+    "tsd": "^0.33.0",
+    "@stripe/extensibility-jsonschema-tools": "0.6.5"
+  },
+  "peerDependencies": {
+    "typescript": "^5.8.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "typesVersions": {
+    "*": {
+      "templates": [
+        "./dist/templates/index.d.ts"
+      ],
+      "dependencies": [
+        "./dist/dependencies/index.d.ts"
+      ],
+      "manifest": [
+        "./dist/manifest/index.d.ts"
+      ],
+      "workspace": [
+        "./dist/workspace/index.d.ts"
+      ],
+      "jsonschema-tools": [
+        "./dist/jsonschema-tools.d.ts"
+      ],
+      "schemas": [
+        "./dist/schemas/index.d.ts"
+      ]
+    }
+  },
+  "scripts": {
+    "build": "pnpm compile && pnpm generate:api-rollups && pnpm generate:api-report",
+    "check:api-report": "pnpm check:api-surface-report",
+    "check:api-surface-report": "tsx ../../scripts/src/api-report-generation/entrypoints/run-package-api-surface-report.ts",
+    "clean": "rimraf dist temp",
+    "compile": "tsc -p tsconfig.build.json --emitDeclarationOnly && tsup",
+    "format": "prettier --write .",
+    "generate:api-report": "pnpm generate:api-surface-report",
+    "generate:api-rollup-root": "api-extractor run --local --config api-extractor-rollup.json",
+    "generate:api-rollup-subpaths": "tsx ../../scripts/src/api-report-generation/entrypoints/run-package-api-subpath-rollups.ts --local",
+    "generate:api-rollups": "pnpm generate:api-rollup-root && pnpm generate:api-rollup-subpaths",
+    "generate:api-surface-report": "tsx ../../scripts/src/api-report-generation/entrypoints/run-package-api-surface-report.ts --local",
+    "lint": "pnpm lint:eslint && pnpm lint:typecheck && pnpm lint:format",
+    "lint:eslint": "eslint .",
+    "lint:format": "prettier --check .",
+    "lint:typecheck": "tsc --noEmit --incremental --tsBuildInfoFile ./dist/tsconfig.check.tsbuildinfo",
+    "normalize:declarations": "declaration-file-normalizer dist/index.d.ts",
+    "test": "vitest run && pnpm test:types",
+    "test:types": "tsc -p tsconfig.build.json --emitDeclarationOnly && tsd --typings dist/index.d.ts --files 'src/**/*.test-d.ts'",
+    "test:watch": "vitest"
+  }
+}

package/templates/extensions/billing.bill.discount_calculation/index.test.ts

@@ -0,0 +1,15 @@
+import { beforeEach, describe, it, expect } from 'vitest';
+
+import MyDiscountCalculation from './index.js';
+
+describe('MyDiscountCalculation', () => {
+  let instance: MyDiscountCalculation;
+
+  beforeEach(() => {
+    instance = new MyDiscountCalculation();
+  });
+
+  it('should be constructable', () => {
+    expect(instance).toBeInstanceOf(MyDiscountCalculation);
+  });
+});

package/templates/extensions/billing.bill.discount_calculation/index.ts

@@ -0,0 +1,20 @@
+import type { Billing } from '@stripe/extensibility-sdk/extensions';
+import type { Context } from '@stripe/extensibility-sdk/extensions';
+
+// eslint-disable-next-line @typescript-eslint/no-empty-object-type
+interface MyDiscountCalculationConfig extends Record<string, unknown> {}
+
+export default class MyDiscountCalculation implements Billing.Bill
+  .DiscountCalculation<MyDiscountCalculationConfig> {
+  computeDiscounts(
+    request: Billing.Bill.DiscountCalculation.DiscountableItem,
+    _config: MyDiscountCalculationConfig,
+    _context: Context
+  ) {
+    // TODO: implement your discount logic here
+
+    return {
+      discount: { amount: request.grossAmount },
+    };
+  }
+}

package/templates/extensions/billing.customer_balance_application/index.test.ts

@@ -0,0 +1,15 @@
+import { beforeEach, describe, it, expect } from 'vitest';
+
+import MyCustomerBalanceApplication from './index.js';
+
+describe('MyCustomerBalanceApplication', () => {
+  let instance: MyCustomerBalanceApplication;
+
+  beforeEach(() => {
+    instance = new MyCustomerBalanceApplication();
+  });
+
+  it('should be constructable', () => {
+    expect(instance).toBeInstanceOf(MyCustomerBalanceApplication);
+  });
+});

package/templates/extensions/billing.customer_balance_application/index.ts

@@ -0,0 +1,18 @@
+import type { Billing, Context } from '@stripe/extensibility-sdk/extensions';
+
+// eslint-disable-next-line @typescript-eslint/no-empty-object-type
+interface MyCustomerBalanceApplicationConfig extends Record<string, unknown> {}
+
+export default class MyCustomerBalanceApplication implements Billing.CustomerBalanceApplication<MyCustomerBalanceApplicationConfig> {
+  computeAppliedCustomerBalance(
+    request: Billing.CustomerBalanceApplication.CustomerBalanceApplicationInput,
+    _config: MyCustomerBalanceApplicationConfig,
+    _context: Context
+  ) {
+    // TODO: implement your customer balance logic here
+
+    return {
+      appliedCustomerBalance: request.customerBalance,
+    };
+  }
+}

package/templates/extensions/billing.invoice_collection_setting/index.test.ts

@@ -0,0 +1,15 @@
+import { beforeEach, describe, it, expect } from 'vitest';
+
+import MyInvoiceCollectionSetting from './index.js';
+
+describe('MyInvoiceCollectionSetting', () => {
+  let instance: MyInvoiceCollectionSetting;
+
+  beforeEach(() => {
+    instance = new MyInvoiceCollectionSetting();
+  });
+
+  it('should be constructable', () => {
+    expect(instance).toBeInstanceOf(MyInvoiceCollectionSetting);
+  });
+});

package/templates/extensions/billing.invoice_collection_setting/index.ts

@@ -0,0 +1,16 @@
+import type { Billing, Context } from '@stripe/extensibility-sdk/extensions';
+
+// eslint-disable-next-line @typescript-eslint/no-empty-object-type
+interface MyInvoiceCollectionSettingConfig extends Record<string, unknown> {}
+
+export default class MyInvoiceCollectionSetting implements Billing.InvoiceCollectionSetting<MyInvoiceCollectionSettingConfig> {
+  collectionOverride(
+    _request: Billing.InvoiceCollectionSetting.InvoiceCollectionRequest,
+    _config: MyInvoiceCollectionSettingConfig,
+    _context: Context
+  ) {
+    // TODO: implement your collection setting logic here
+
+    return {};
+  }
+}

package/templates/extensions/billing.prorations/index.test.ts

@@ -0,0 +1,15 @@
+import { beforeEach, describe, it, expect } from 'vitest';
+
+import MyProrations from './index.js';
+
+describe('MyProrations', () => {
+  let instance: MyProrations;
+
+  beforeEach(() => {
+    instance = new MyProrations();
+  });
+
+  it('should be constructable', () => {
+    expect(instance).toBeInstanceOf(MyProrations);
+  });
+});

package/templates/extensions/billing.prorations/index.ts

@@ -0,0 +1,18 @@
+import type { Billing, Context } from '@stripe/extensibility-sdk/extensions';
+
+// eslint-disable-next-line @typescript-eslint/no-empty-object-type
+interface MyProrationsConfig extends Record<string, unknown> {}
+
+export default class MyProrations implements Billing.Prorations<MyProrationsConfig> {
+  prorateItems(
+    _request: Billing.Prorations.ProrateItemsInput,
+    _config: MyProrationsConfig,
+    _context: Context
+  ) {
+    // TODO: implement your proration logic here
+
+    return {
+      items: [],
+    };
+  }
+}

package/templates/extensions/billing.recurring_billing_item_handling/index.test.ts

@@ -0,0 +1,15 @@
+import { beforeEach, describe, it, expect } from 'vitest';
+
+import MyRecurringBillingItemHandling from './index.js';
+
+describe('MyRecurringBillingItemHandling', () => {
+  let instance: MyRecurringBillingItemHandling;
+
+  beforeEach(() => {
+    instance = new MyRecurringBillingItemHandling();
+  });
+
+  it('should be constructable', () => {
+    expect(instance).toBeInstanceOf(MyRecurringBillingItemHandling);
+  });
+});

package/templates/extensions/billing.recurring_billing_item_handling/index.ts

@@ -0,0 +1,42 @@
+import type { Billing, Context } from '@stripe/extensibility-sdk/extensions';
+
+// eslint-disable-next-line @typescript-eslint/no-empty-object-type
+interface MyRecurringBillingItemHandlingConfig extends Record<string, unknown> {}
+
+export default class MyRecurringBillingItemHandling implements Billing.RecurringBillingItemHandling<MyRecurringBillingItemHandlingConfig> {
+  beforeItemCreation(
+    _request: Billing.RecurringBillingItemHandling.BeforeItemCreationInput,
+    _config: MyRecurringBillingItemHandlingConfig,
+    _context: Context
+  ) {
+    // TODO: implement your before-item-creation logic here
+
+    return {
+      items: [],
+    };
+  }
+
+  filterItems(
+    _request: Billing.RecurringBillingItemHandling.FilterItemsInput,
+    _config: MyRecurringBillingItemHandlingConfig,
+    _context: Context
+  ) {
+    // TODO: implement your filter-items logic here
+
+    return {
+      items: [],
+    };
+  }
+
+  groupItems(
+    _request: Billing.RecurringBillingItemHandling.GroupItemsInput,
+    _config: MyRecurringBillingItemHandlingConfig,
+    _context: Context
+  ) {
+    // TODO: implement your group-items logic here
+
+    return {
+      groups: [],
+    };
+  }
+}

package/templates/extensions/common/.prettierignore

@@ -0,0 +1,3 @@
+dist
+generated
+node_modules

package/templates/extensions/common/eslint.config.mts.mustache

@@ -0,0 +1,95 @@
+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 extensionTypeConfig from '@stripe/extensibility-eslint-plugin/{{extensionInterfaceId}}';
+
+export default defineConfig([
+  eslint.configs.recommended,
+  ...tseslint.configs.recommended,
+  ...stripeAppsConfig,
+  ...extensionTypeConfig,
+
+  // 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 (type-checking, relaxed rules)
+  {
+    name: 'tests',
+    files: ['src/**/*.test.ts', 'src/**/__tests__/**/*.ts'],
+    languageOptions: {
+      globals: {
+        ...globals.node,
+      },
+      parserOptions: {
+        projectService: true,
+        tsconfigRootDir: import.meta.dirname,
+      },
+    },
+    rules: {
+      '@typescript-eslint/no-explicit-any': 'off',
+      '@typescript-eslint/no-unused-vars': 'off',
+      'no-console': 'off',
+    },
+  },
+
+  // 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)
+  {
+    name: 'js-configs',
+    files: ['**/*.js', '**/*.mjs'],
+    languageOptions: {
+      globals: {
+        ...globals.node,
+      },
+      parserOptions: {
+        projectService: false,
+      },
+    },
+    rules: {
+      '@typescript-eslint/no-require-imports': 'off',
+      '@typescript-eslint/no-unused-vars': 'off',
+      'no-unused-vars': 'off',
+    },
+  },
+
+  eslintConfigPrettier,
+]);

package/templates/extensions/common/package.json.mustache

@@ -0,0 +1,26 @@
+{
+  "name": "{{id}}",
+  "version": "{{version}}",
+  "description": "{{name}}",
+  "private": true,
+  "license": "~~proprietary~~",
+  "type": "module",
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json && pnpm build:schemas",
+    "build:schemas": "gen-schemas --root ../.. --extension-id \"$npm_package_name\" --out-dir generated --schema-name config",
+    "lint": "pnpm lint:types && pnpm lint:eslint && pnpm lint:format",
+    "lint:types": "tsc -p tsconfig.build.json --noEmit && tsc -p tsconfig.json --noEmit",
+    "lint:eslint": "eslint .",
+    "lint:format": "prettier --check .",
+    "fix:lint": "eslint --fix .",
+    "fix:format": "prettier --write .",
+    "test": "vitest --root ../.. run --project \"$npm_package_name\"",
+    "test:watch": "pnpm test --watch",
+    "dev": "concurrently -n build,lint,test -c blue,yellow,green 'tsc -p tsconfig.json -w --noEmit' 'chokidar \"src/**/*.{ts,json}\" -c \"eslint .\"' 'pnpm test --watch --no-clear-screen'",
+    "stripe:regen": "gen-workspace --root ../.. --package-dir . --template-id {{extensionInterfaceId}}"
+  },
+  "lint-staged": {
+    "*.{ts,mts,mjs,js}": ["eslint --fix", "prettier --write"],
+    "*.{json,md,yaml}": "prettier --write"
+  }
+}

package/templates/extensions/common/tsconfig.build.json.mustache

@@ -0,0 +1,15 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "lib": null,
+    "noLib": true,
+    "outDir": "./dist",
+    "rootDir": "./src"
+  },
+  "include": [
+    "src/**/*.ts",
+    "node_modules/@stripe/extensibility-sdk/tslibs/5.9.3/lib.es2022.{{executionProfile}}.d.ts",
+    "node_modules/@stripe/extensibility-sdk/tslibs/lib.{{executionProfile}}.globals.d.ts"
+  ],
+  "exclude": ["src/**/*.test.ts", "src/**/__tests__"]
+}

package/templates/extensions/common/tsconfig.json.mustache

@@ -0,0 +1,16 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "rootDir": ".",
+    "plugins": [
+      {
+        "name": "@stripe/extensibility-language-server/plugin"
+      }
+    ]
+  },
+  "include": [
+    "src/**/*.ts",
+    "node_modules/@stripe/extensibility-sdk/tslibs/lib.{{executionProfile}}.globals.d.ts"
+  ],
+  "exclude": ["dist"]
+}

package/templates/extensions/core.workflows.custom_action/custom_input.schema.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {},
+  "additionalProperties": false
+}

package/templates/extensions/core.workflows.custom_action/index.test.ts

@@ -0,0 +1,15 @@
+import { beforeEach, describe, it, expect } from 'vitest';
+
+import MyCustomAction from './index.js';
+
+describe('MyCustomAction', () => {
+  let instance: MyCustomAction;
+
+  beforeEach(() => {
+    instance = new MyCustomAction();
+  });
+
+  it('should be constructable', () => {
+    expect(instance).toBeInstanceOf(MyCustomAction);
+  });
+});

package/templates/extensions/core.workflows.custom_action/index.ts

@@ -0,0 +1,31 @@
+import type { Core } from '@stripe/extensibility-sdk/extensions';
+import type { Context } from '@stripe/extensibility-sdk/extensions';
+
+// eslint-disable-next-line @typescript-eslint/no-empty-object-type
+interface MyCustomActionConfig extends Record<string, unknown> {}
+
+export default class MyCustomAction implements Core.Workflows
+  .CustomAction<MyCustomActionConfig> {
+  execute(
+    _request: Core.Workflows.CustomAction.ExecuteCustomActionRequest,
+    _config: MyCustomActionConfig,
+    _context: Context
+  ) {
+    // TODO: implement your action logic here
+
+    return {};
+  }
+
+  getFormState(
+    _request: Core.Workflows.CustomAction.GetFormStateRequest,
+    _config: MyCustomActionConfig,
+    _context: Context
+  ) {
+    // TODO: implement your logic here
+
+    return {
+      values: {},
+      config: {},
+    };
+  }
+}

package/templates/extensions/extend.workflows.custom_action/custom_input.schema.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {},
+  "additionalProperties": false
+}

package/templates/extensions/extend.workflows.custom_action/index.test.ts

@@ -0,0 +1,15 @@
+import { beforeEach, describe, it, expect } from 'vitest';
+
+import MyCustomAction from './index.js';
+
+describe('MyCustomAction', () => {
+  let instance: MyCustomAction;
+
+  beforeEach(() => {
+    instance = new MyCustomAction();
+  });
+
+  it('should be constructable', () => {
+    expect(instance).toBeInstanceOf(MyCustomAction);
+  });
+});

package/templates/extensions/extend.workflows.custom_action/index.ts

@@ -0,0 +1,31 @@
+import type { Extend } from '@stripe/extensibility-sdk/extensions';
+import type { Context } from '@stripe/extensibility-sdk/extensions';
+
+// eslint-disable-next-line @typescript-eslint/no-empty-object-type
+interface MyCustomActionConfig extends Record<string, unknown> {}
+
+export default class MyCustomAction implements Extend.Workflows
+  .CustomAction<MyCustomActionConfig> {
+  execute(
+    _request: Extend.Workflows.CustomAction.ExecuteCustomActionRequest,
+    _config: MyCustomActionConfig,
+    _context: Context
+  ) {
+    // TODO: implement your action logic here
+
+    return {};
+  }
+
+  getFormState(
+    _request: Extend.Workflows.CustomAction.GetFormStateRequest,
+    _config: MyCustomActionConfig,
+    _context: Context
+  ) {
+    // TODO: implement your logic here
+
+    return {
+      values: {},
+      config: {},
+    };
+  }
+}

package/templates/root/.husky/pre-commit

@@ -0,0 +1 @@
+pnpm lint-staged

package/templates/root/.prettierignore

@@ -0,0 +1,5 @@
+dist
+generated
+node_modules
+pnpm-lock.yaml
+.build

package/templates/root/.prettierrc

@@ -0,0 +1,7 @@
+{
+  "semi": true,
+  "singleQuote": true,
+  "tabWidth": 2,
+  "trailingComma": "es5",
+  "printWidth": 90
+}

package/templates/root/_gitignore

@@ -0,0 +1,28 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+*~
+
+# dependencies
+node_modules
+dist
+
+# testing
+/coverage
+
+# production
+/.build
+
+# misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+install-deps.log
+
+# generated schemas
+generated