@nocobase/app-cli-distribution 0.0.0-stage → 0.1.0-beta.0

package/LICENSE.txt

@@ -0,0 +1,129 @@
+Updated Date: November 7, 2026
+
+NocoBase License Agreement
+
+NOCOBASE PTE. LTD., a Singaporean Exempt Private Company Limited by Shares with its principal place of business located at 112 ROBINSON ROAD, #03-01, SINGAPORE ("The Company") https://www.nocobase.com/ issues this License Agreement ("Agreement") to you. You, as an individual or a company ("The User"), will be deemed to voluntarily accept all terms of this Agreement by using NocoBase (including but not limited to obtaining NocoBase source code, installation package, or image in any form, installing and using NocoBase, developing Applications with NocoBase, purchasing NocoBase commercial license and services). If the User does not agree to any term of this Agreement, or cannot accurately understand our interpretation of the relevant terms, please stop using it immediately.
+
+This Agreement applies to any use, quotation, contract, invoice, and all software delivered by the Company. The User and the Company or NocoBase's agents need not sign a separate license agreement for the sale and delivery of the software.
+
+This Agreement applies to NocoBase 3 and later versions. NocoBase 2 and earlier versions are independent products and remain subject to their original license agreement. Where a NocoBase 2 Commercial Edition user uses NocoBase 3 or later versions under a policy announced by the Company, that use is subject to this Agreement.
+
+The Company reserves the right to formulate and modify this Agreement from time to time as needed. If there are changes, the Company will announce them in the form of website announcements, without further individual notification. The changed Agreement will automatically take effect once it is announced, becoming part of this Agreement.
+
+==============
+1. Definitions
+==============
+
+1.1 "Software" refers to NocoBase, consisting of Core, Studio, and Commercial Plugins, including their source code, installation packages, images, and all their modifications, updates, and upgrades.
+
+1.2 "Core" refers to NocoBase Core, the open source application foundation released by the Company, including the runtime, plugins, application templates, development standards, and development skills placed in the same code repository.
+
+1.3 "Studio" refers to NocoBase Studio, the governance platform for people and agents building software together, provided in the Commercial Edition.
+
+1.4 "Commercial Plugins" refers to the plugins provided in the Commercial Edition that extend the capabilities of Core, such as advanced approvals and enterprise SSO.
+
+1.5 "Community Edition" refers to the free version of the Software provided to the User through public channels, namely Core.
+
+1.6 "Commercial Edition" refers to the paid version of the Software purchased by the User from the Company or its agents, downloaded through exclusive channels, and includes additional benefits. In addition to Core, it includes Studio and Commercial Plugins, and consists of two versions: Professional Edition and Enterprise Edition.
+
+1.7 "Application" refers to a specific business use case application serving internal or external customers of the User, developed based on the Software, such as ERP/CRM. Studio is a development tool and is not part of any Application.
+
+1.8 "Customer" refers to the clients who commission the User to develop Applications or purchase the User's Applications.
+
+1.9 "Agent" refers to an AI agent that works with the Software, including the coding agents the User uses to develop Applications and the business agents in Applications.
+
+1.10 "Third-Party Services" refers to the large models, coding agents, cloud services, and other third-party products and services that the User chooses to use with the Software.
+
+1.11 "Third-Party Open Source Software" refers to open source software provided with the Software. They are licensed through various published open source software licenses or copyright notices accompanying such software.
+
+===================================
+2. Intellectual Property Protection
+===================================
+
+Except for Third-Party Open Source Software, the Company owns all copyrights, trademark rights, patent rights, trade secrets, and other intellectual property rights of the Software, and has registered and protected them in relevant countries and regions according to the "Paris Convention" or "TRIPS Agreement", ensuring that the intellectual property rights of the Software are internationally recognized and protected.
+
+The Company claims no intellectual property rights in the business code written by the User or by Agents when developing Applications, or in the User's business data, skills, and knowledge bases. The parts of the Software contained in an Application remain the intellectual property of the Company and are subject to this Agreement.
+
+=============
+3. Disclaimer
+=============
+
+3.1 The User shall not use the Software to engage in activities that contravene applicable laws and regulations or offend against public order or religious prohibitions. All legal liabilities and consequences arising from the User's use shall be borne by the User.
+
+3.2 The Company shall not be liable for any direct, indirect, special, incidental, or consequential damages (including but not limited to loss of profits, business interruption, data loss, or business information disclosure) caused by the User's use of the Software, even if it has been previously informed of the possibility of such damages.
+
+3.3 Code written, content generated, and actions taken by Agents shall be reviewed and accepted by the User before being used in production. All consequences arising from the use of the work of Agents shall be borne by the User.
+
+3.4 Third-Party Services are chosen and paid for by the User and are subject to their own terms. The Company shall not be liable for the availability, output, or data handling of Third-Party Services.
+
+===============
+4. License Type
+===============
+
+4.1 This Agreement serves as the unified license agreement for NocoBase Software, applying to both the Community Edition and the Commercial Editions.
+
+4.2 Core is open source software. This Agreement incorporates and references the full text of the Apache License, Version 2.0 ("Apache-2.0", available at: https://www.apache.org/licenses/LICENSE-2.0 ). Users of Core must comply with the Apache-2.0 License as well as the supplementary terms set forth in this Agreement. In case of any inconsistency between Apache-2.0 and this Agreement, the supplementary terms of this Agreement shall prevail.
+
+4.3 Studio and Commercial Plugins are commercial software of the Company and are not licensed under Apache-2.0. They can only be used under the Commercial License and in accordance with this Agreement.
+
+================================================
+5. Rights and Obligations of Open Source License
+================================================
+
+5.1 The Community Edition can be used for commercial purposes, including developing Applications for Customers.
+
+5.2 It is not allowed to remove or change the NocoBase statement "AI + NocoBase" and "Build reliable business systems", or its link to https://www.nocobase.com/, at the bottom left of the interface of any Application, including Applications delivered to Customers, even though the code that displays the statement is part of the Application. If the default layout is replaced, the statement shall be kept at an equally visible position on the main interface of the Application. Pages that can be accessed without signing in and pages embedded in other systems are not subject to this requirement. When the sidebar is collapsed, showing the statement as an icon with a tooltip, as provided by default, meets this requirement. The main LOGO in the upper left corner of the page, the version number, and other information on the interface can be changed.
+
+5.3 It is not allowed to remove or change all intellectual property statements about NocoBase in the code.
+
+5.4 It is not allowed to provide to the public any form of AI application development platform or agent development platform SaaS/PaaS products using the original or modified Software.
+
+===============================
+6. Rights of Commercial License
+===============================
+
+6.1 Obtain a permanent commercial license of the Software.
+
+6.2 Can develop Applications for Customers, deploy the completed Applications, including the Commercial Plugins they use, on Customers' servers, or host them and provide them to Customers as a service. This does not include Studio.
+
+6.3 Customers can use the Commercial Plugins in the Applications delivered to them, within those Applications only, and can continue to develop those Applications on their own or through others.
+
+6.4 Get software upgrades and exclusive technical support during the upgrade validity period. Upgrades and technical support are provided to the User only, and the User can upgrade the Commercial Plugins in Applications delivered to Customers during this period.
+
+6.5 The licensed Software can be used for commercial purposes with no restrictions on the number of Applications, Customers, users, and Agents.
+
+6.6 Can remove or change the NocoBase statement described in 5.2, and the brand, name, link, and other information about NocoBase on the interface of Applications.
+
+6.7 If there are other agreements in the contract for the above rights, the contract agreement shall prevail.
+
+====================================
+7. Obligations of Commercial License
+====================================
+
+7.1 It is not allowed to remove or change all intellectual property statements about NocoBase in the code.
+
+7.2 It is not allowed to sell, transfer, lease, share, gift, or distribute the Commercial License. Deploying Applications for Customers under 6.2 is not considered sharing the Commercial License, but the license key, access token, or other credentials of the Commercial License shall not be provided to Customers for any purpose other than deploying and running the Applications delivered to them.
+
+7.3 It is not allowed to sell, transfer, lease, share, or distribute any form of AI application development platform, agent development platform, or developer tools developed based on Software.
+
+7.4 It is not allowed to provide any form of AI application development platform or agent development platform SaaS/PaaS products to the public using the original or modified Software.
+
+7.5 Studio can only be used by the User holding the Commercial License, on servers owned or rented by the User. It is not allowed to deploy Studio for Customers, or to provide Studio to Customers or any third party in any form, including as a hosted service. Customers that need Studio shall purchase their own Commercial License.
+
+7.6 Customer personnel can take part in requirement confirmation, acceptance, and release approval in the User's Studio for the Applications the User develops for them. This is not considered providing Studio to Customers, but it is not allowed to let Customers use Studio to develop their own projects.
+
+7.7 If there is a violation of the above obligations or the terms of this Agreement, the rights owned by the User will be immediately terminated, the paid fees will not be refunded, and the Company reserves the right to pursue the User's legal responsibility.
+
+7.8 If there are other agreements in the contract for the above obligations, the contract agreement shall prevail.
+
+=============================================================
+8. Legal Jurisdiction, Interpretation, and Dispute Resolution
+=============================================================
+
+8.1 Except for Mainland China, the interpretation, application, and all matters related to this agreement are subject to the jurisdiction of Singapore law.
+
+8.2 Any dispute related to this Agreement should first be resolved through friendly negotiation. If the negotiation fails to resolve the dispute, the dispute should be submitted to the International Chamber of Commerce (ICC) for arbitration. The arbitration venue should be Singapore, conducted in English.
+
+8.3 All terms and conditions of this Agreement shall be deemed enforceable to the maximum extent permitted by applicable law. If any term of this Agreement is deemed invalid by any applicable law, the invalidity of that term does not affect the validity of any other term of this Agreement, and it should be deemed that the invalid term has been modified as much as possible to make it valid and enforceable, or if the term cannot be modified, it should be deemed to have been deleted from this Agreement.
+
+8.4 The arbitration award is final, binding on both parties, and can be enforced in any court with jurisdiction.

package/README.md

@@ -1,3 +1,80 @@
-# Temporary Holding Version
+# @nocobase/app-cli-distribution
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Server-side artifact distribution and CLI installation without registering Agents. The package has no database, migrations, jobs, Runner service, registration flow or frontend. Agents uses the same implementation with its original credentials, table and HTTP contract.
+
+## Mounting a CLI-only host
+
+Create one artifact store per host configuration so its manifest cache is retained. Mount both routers at `/api/agents/dist` (below the application's base path): existing installed CLIs use these paths for `update`. Build artifacts with `nocobase cli build --universal --out <artifact-directory>`, or platform-specific targets. The layout is `<directory>/<channel>/<product>/manifest.json` and the files that manifest lists.
+
+```ts
+import { Hono } from 'hono';
+import {
+  createArtifactStore,
+  createDistributionRoutes,
+  createInstallRoutes,
+} from '@nocobase/app-cli-distribution';
+
+const artifacts = createArtifactStore({ dir: artifactDirectory });
+const distribution = new Hono()
+  .route(
+    '/',
+    createDistributionRoutes({
+      artifacts,
+      products: ['acme'],
+      // Supply the host's real authentication middleware. The host decides
+      // whether a session, API key or another credential may download.
+      fallback: requireSignedInPerson,
+    }),
+  )
+  .route(
+    '/',
+    createInstallRoutes({
+      cli: () => 'acme',
+      publicOrigin: () => publicOrigin,
+      publicBasePath: '/main',
+    }),
+  );
+app.route('/api/agents/dist', distribution);
+```
+
+`app` is the host's Hono API router. A NocoBase host contributes this router through its normal server routes declaration; it does not register the Agents plugin. `products` restricts manifest entries, resolution and file requests, including npm resolution. It is required: pass the CLI allowlist, or explicitly pass `'all'` to serve every configured product as Agents does. Omitting it throws when the router is created. A request for another product receives 404 after authorization. The artifact directory and manifests are trusted deployment inputs; isolate them from user uploads and untrusted filesystem writers. Files cannot escape their product directory through a manifest path.
+
+## Authorization is explicit
+
+No artifact is public by default. `admissions` are ordered asynchronous handlers: return `false` when the handler recognizes no credential, return `true` after authorizing it, and throw on an invalid recognized credential. An error never falls through to another handler or a signed-in session. After every handler declines, `fallback` may authorize through the host. With neither an accepting handler nor a fallback, requests receive 401 `UNAUTHORIZED` in the existing `agents` error domain. Never use download credentials as business login credentials.
+
+The package implements no public-download strategy or signed credential protocol. A host can write its own authorization middleware, which makes its security policy the host's responsibility. Choosing Main's policy, any public access, and any new persistent token store require a separate product decision. This package does not select one or create a table.
+
+`createInstallRoutes` serves a public script containing no credential. The CLI-only script accepts `--token`, `--server`, `--prefix`, `--bin-dir`, `--dry-run`, `-h` and `--help`; it sends the token in `x-nocobase-download-token`. A session-only host can resolve/download/update through its authenticated clients, but must supply an installation credential admission if it wants this token-based one-line installation. The `InstallScriptExtensions.credentials` hook may implement another host-approved installation transport. No Runner flags, registration or services are in the default script.
+
+## Optional stateful download tokens
+
+`createDownloadTokenService({ product, store, clock, ids })` implements the existing algorithm: 32 random bytes with the protocol prefix, SHA-256-only storage, 30 minutes, three tarball downloads, and the first requested platform binding. Pass its `downloadTokenAdmission(tokens, artifacts)` in `admissions`. Only when `mint: { guard, tokens, createdBy }` is supplied does the router expose `POST /downloadTokens`; the guard must authenticate and authorize the creator, and `createdBy(context)` supplies its user id. Agents keeps its existing person guard, including refusal of scoped API keys.
+
+`DownloadTokenStore.transaction(fn)` supplies `insert(record)`, `findByHash(hash)` and `updateIfDownloads(id, expected, values)` on one host-owned transaction. Reads must return snapshots; the update must atomically match both id and expected downloads and return whether exactly one row changed. Roll back when the callback throws. Preserve null target values and string timestamps. The in-memory adapter under `tests/` is test-only and does not promise durable storage or production transaction isolation.
+
+Agents adapts the unchanged `agDownloadTokens` repository and its existing transaction runner. No table or historical migration moves, and live pre-upgrade hashes remain usable. Its file authorization still checks token validity before lookup, then binds/counts the actual platform, using two admissions. Failed or cancelled transfers consume a download credit as before.
+
+## Artifact and script contracts
+
+The artifact store selects the highest version or an explicitly pinned version, uses a platform tarball before a universal tarball, and falls back to configured npm packages only when a caller accepts npm and no current artifact exists. Only manifest-listed files are sent, with stat-derived length, SHA-256 metadata and the existing cache headers. Manifest parsing is cached by modification time. File bodies use `createReadStream` and `Readable.toWeb`; cancellation destroys the underlying stream, without buffering the archive.
+
+The default script verifies SHA-256, installs platform/universal/npm packages, writes `install.json` with `mode: cli`, switches `current`, restarts saved ACP connections and prints PATH/sign-in guidance. It retains `NOCOBASE_CLI_INSTALL_DIR`, `NOCOBASE_CLI_BIN_DIR`, `NOCOBASE_CLI_TARGET` and `NOCOBASE_NPM`. `requestedServer` preserves public origin, forwarded origin and base-path handling and refuses unsafe shell defaults.
+
+`InstallScriptExtensions` contains trusted shell fragments for usage, initialization, argument parsing, validation, credential transport, preparation, resolution failures, and post-install actions. These are executable host code, never HTTP input or user configuration. Agents supplies its Runner-specific fragments through this interface, while sharing all archive selection, checksum, npm and installation logic. `openapi` overrides on both route factories let a host describe its actual authentication policy; Agents supplies its unchanged operation ids, tags, descriptions and security declarations.
+
+## Compatibility and verification
+
+| Existing Agents endpoint                               | Preserved behavior                                                                                                                |
+| ------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |
+| `POST /downloadTokens`                                 | Person guard; scoped-key refusal; 201 `{ data: { token, expiresAt, maxDownloads } }`; hidden from CLI discovery                   |
+| `GET /installScript`                                   | Public; shell content type; no-cache; all existing CLI and Runner flags, environment variables, errors and request behavior       |
+| `GET /manifest`                                        | Runner key without touch, download token, unused registration token, then session/API-key fallback; original error reasons        |
+| `GET /products/:product/targets/:target`               | `format=env`, `accept=npm`, universal fallback, unsupported-platform details, original 404 reasons, no-store                      |
+| `GET /products/:product/versions/:version/files/:file` | Authorization before file existence, platform binding and credit counting; gzip stream, length, checksum, immutable private cache |
+
+The new package's host tests exercise protected defaults, an explicit session policy, an in-memory token policy, product restrictions, invalid manifests, missing/unlisted/escaping files and stream cancellation without Agents. Agents' unchanged distribution/install/client/work/OpenAPI tests cover its adapter; the upgrade suite inserts old-shaped records directly and checks expiry, first platform, limits and concurrent final-credit consumption. Real installation/update and RSS measurements are local checks reported with the change, not CI cases.
+
+The extraction adds no database query, write, lock or transaction to an Agents request and no polling or Runner claim work. Token mint remains one insert/transaction; metadata admission one read/transaction plus a conditional update when binding; a token file request remains two reads/transactions and one conditional counting update. The product restriction adds an in-memory membership check. No independent-host database or jobs are required.
+
+Main integration and UI, its authorization choice, signed tokens/public downloads, token cleanup, mode switching between independent distribution and Agents, and the client's full-buffer update download remain separate work. One router owns `/api/agents/dist` in a host; do not register both independent distribution and Agents at that prefix.

package/dist/artifacts.d.ts

@@ -0,0 +1,72 @@
+/**
+ * Distribution: the runner (`nocobase-runner`) and the application's CLI (such as `acme`), served by the application
+ * itself as tarballs, so nothing is published to a registry: one per target, each bundling Node, or one for every
+ * target (`UNIVERSAL_TARGET`, `nocobase cli build --universal`) that runs on the machine's own Node.js 24 or newer.
+ *
+ * `nocobase cli build` of `@nocobase/app-cli` (`--runner` for the runner) builds each product into a directory of its
+ * own, with its own manifest, so the products are built and mounted apart (in CI, one artifact each):
+ *
+ *   <dir>/<channel>/<product>/manifest.json
+ *   <dir>/<channel>/<product>/<version>/<product>-v<version>-<target>.tar.gz
+ *
+ * where a product's manifest lists its versions with each target's file (relative to the product's directory),
+ * SHA-256 and size. A target without a file of its own gets the version's universal one, if it has one, answered with
+ * `universal: true`; a file built for the target wins over it. The application serves one channel (`agents.dist.channel`, `stable` by default); a product's
+ * current version is the one `agents.dist.versions` pins, or the highest the channel has. Only files a manifest lists
+ * are ever served.
+ *
+ * A product the directory has no current version of may instead be named on the npm registry (`agents.dist.npm`: its
+ * package and exact version), answered only to callers that understand it (`npmPackage`). The directory always wins.
+ */
+import { type ReadStream } from 'node:fs';
+import { type DistArtifact, type DistManifest, type DistNpmPackage } from '@nocobase/agent-protocol';
+/** `agents.dist` in the application's configuration. */
+export interface DistConfig {
+    /** Where the built tarballs are; `storage/runners/dist` of the application by default. */
+    readonly dir?: string;
+    /** Which channel to serve: `stable` by default. */
+    readonly channel?: string;
+    /** A version to serve per product instead of the channel's highest, such as `{ acme: '0.3.1' }`. */
+    readonly versions?: Readonly<Record<string, string>>;
+    /**
+     * The npm package and exact version each product is published as, such as
+     * `{ 'nocobase-runner': { package: '@nocobase/agent-runner', version: '1.0.0' } }`: answered instead of a tarball
+     * only when `dir` has no current version of the product, and only to callers that understand it (`DistNpmPackage`).
+     */
+    readonly npm?: Readonly<Record<string, DistNpmSource>>;
+}
+/** One product of `DistConfig.npm`. */
+export interface DistNpmSource {
+    readonly package: string;
+    /** An exact version, never a range. */
+    readonly version: string;
+}
+export declare const DEFAULT_CHANNEL = "stable";
+/** A file the application may serve, found through the manifest. */
+export interface DistFile {
+    /** The platform it is built for: `UNIVERSAL_TARGET` for the one that serves every platform. */
+    readonly target: string;
+    readonly path: string;
+    readonly sha256: string;
+    readonly size: number;
+    open(): ReadStream;
+}
+export interface DistService {
+    readonly channel: string;
+    /** What the channel serves now; empty when nothing was built. */
+    manifest(): Promise<DistManifest>;
+    /** The current `product` for `target`, or null. */
+    find(product: string, target: string): Promise<DistArtifact | null>;
+    /** Like `find`, but 404: `PLATFORM_UNSUPPORTED` with the targets there are, or `NOT_FOUND` for no such product. */
+    resolve(product: string, target: string): Promise<DistArtifact>;
+    /** A file the manifest lists (any version on the channel); 404 otherwise. */
+    file(product: string, version: string, name: string): Promise<DistFile>;
+    /**
+     * The npm package to install `product` from (`DistConfig.npm`), or null when none is configured or the directory has
+     * a current version of the product, which is then served as a tarball exactly as without it. Only for callers that
+     * understand the answer: the resolve route's `accept=npm`, a runner with the `npm` feature.
+     */
+    npmPackage(product: string): Promise<DistNpmPackage | null>;
+}
+export declare function createArtifactStore(config?: DistConfig): DistService;
+//# sourceMappingURL=artifacts.d.ts.map

package/dist/artifacts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"artifacts.d.ts","sourceRoot":"","sources":["../src/artifacts.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AACH,OAAO,EAAoB,KAAK,UAAU,EAAE,MAAM,SAAS,CAAC;AAI5D,OAAO,EASL,KAAK,YAAY,EACjB,KAAK,YAAY,EAEjB,KAAK,cAAc,EACpB,MAAM,0BAA0B,CAAC;AAUlC,wDAAwD;AACxD,MAAM,WAAW,UAAU;IACzB,0FAA0F;IAC1F,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC;IACtB,mDAAmD;IACnD,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,oGAAoG;IACpG,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IACrD;;;;OAIG;IACH,QAAQ,CAAC,GAAG,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC,CAAC;CACxD;AAED,uCAAuC;AACvC,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,uCAAuC;IACvC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B;AAUD,eAAO,MAAM,eAAe,WAAW,CAAC;AA6BxC,oEAAoE;AACpE,MAAM,WAAW,QAAQ;IACvB,+FAA+F;IAC/F,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,IAAI,IAAI,UAAU,CAAC;CACpB;AAED,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,iEAAiE;IACjE,QAAQ,IAAI,OAAO,CAAC,YAAY,CAAC,CAAC;IAClC,mDAAmD;IACnD,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC,CAAC;IACpE,mHAAmH;IACnH,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAChE,6EAA6E;IAC7E,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IACxE;;;;OAIG;IACH,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC,CAAC;CAC7D;AAED,wBAAgB,mBAAmB,CAAC,MAAM,GAAE,UAAe,GAAG,WAAW,CAgNxE"}

package/dist/artifacts.js

@@ -0,0 +1,239 @@
+/**
+ * Distribution: the runner (`nocobase-runner`) and the application's CLI (such as `acme`), served by the application
+ * itself as tarballs, so nothing is published to a registry: one per target, each bundling Node, or one for every
+ * target (`UNIVERSAL_TARGET`, `nocobase cli build --universal`) that runs on the machine's own Node.js 24 or newer.
+ *
+ * `nocobase cli build` of `@nocobase/app-cli` (`--runner` for the runner) builds each product into a directory of its
+ * own, with its own manifest, so the products are built and mounted apart (in CI, one artifact each):
+ *
+ *   <dir>/<channel>/<product>/manifest.json
+ *   <dir>/<channel>/<product>/<version>/<product>-v<version>-<target>.tar.gz
+ *
+ * where a product's manifest lists its versions with each target's file (relative to the product's directory),
+ * SHA-256 and size. A target without a file of its own gets the version's universal one, if it has one, answered with
+ * `universal: true`; a file built for the target wins over it. The application serves one channel (`agents.dist.channel`, `stable` by default); a product's
+ * current version is the one `agents.dist.versions` pins, or the highest the channel has. Only files a manifest lists
+ * are ever served.
+ *
+ * A product the directory has no current version of may instead be named on the npm registry (`agents.dist.npm`: its
+ * package and exact version), answered only to callers that understand it (`npmPackage`). The directory always wins.
+ */
+import { createReadStream } from 'node:fs';
+import { readdir, readFile, stat } from 'node:fs/promises';
+import path from 'node:path';
+import { compareVersions, DIST_PRODUCT_PATTERN, DIST_ROUTES, DIST_TARGET_PATTERN, EXACT_VERSION_PATTERN, NPM_PACKAGE_PATTERN, ProtocolError, routePath, UNIVERSAL_TARGET, } from '@nocobase/agent-protocol';
+import { z } from 'zod';
+function notFound(what) {
+    return new ProtocolError(what === 'Product' ? 'PRODUCT_NOT_FOUND' : 'DIST_FILE_NOT_FOUND', `${what} not found.`);
+}
+const DistNpmConfigSchema = z.record(z.string().regex(DIST_PRODUCT_PATTERN), z.object({
+    package: z.string().max(214).regex(NPM_PACKAGE_PATTERN),
+    version: z.string().max(64).regex(EXACT_VERSION_PATTERN),
+}));
+export const DEFAULT_CHANNEL = 'stable';
+const StoredTargetSchema = z.object({
+    file: z.string().min(1),
+    sha256: z.string().regex(/^[0-9a-f]{64}$/u),
+    size: z.number().int().nonnegative(),
+});
+const StoredVersionsSchema = z.record(z.string(), z.object({ targets: z.record(z.string(), StoredTargetSchema) }));
+/** The manifest of one product, `<channel>/<product>/manifest.json`, with files relative to the product's directory. */
+const ProductManifestSchema = z.object({
+    schema: z.literal(1),
+    product: z.string().regex(DIST_PRODUCT_PATTERN),
+    bin: z.string().optional(),
+    versions: StoredVersionsSchema,
+});
+export function createArtifactStore(config = {}) {
+    const channel = config.channel ?? DEFAULT_CHANNEL;
+    const npmSources = parseNpmSources(config.npm);
+    const channelDir = config.dir === undefined ? null : path.resolve(config.dir, channel);
+    let cache;
+    /** Each product's manifest file with its modification time, or nothing when there is none. */
+    const manifestFiles = async () => {
+        if (channelDir === null)
+            return [];
+        const found = [];
+        let entries;
+        try {
+            entries = (await readdir(channelDir)).sort();
+        }
+        catch {
+            return found;
+        }
+        for (const product of entries) {
+            if (!DIST_PRODUCT_PATTERN.test(product))
+                continue;
+            const file = path.join(channelDir, product, 'manifest.json');
+            try {
+                found.push({ file, product, mtimeMs: (await stat(file)).mtimeMs });
+            }
+            catch {
+                // A product not built yet.
+            }
+        }
+        return found;
+    };
+    const readManifest = async (file) => {
+        try {
+            return JSON.parse(await readFile(file, 'utf8'));
+        }
+        catch {
+            return undefined;
+        }
+    };
+    const load = async () => {
+        const files = await manifestFiles();
+        if (files.length === 0) {
+            cache = undefined;
+            return null;
+        }
+        const key = files
+            .map((entry) => `${entry.file}:${entry.mtimeMs}`)
+            .join('|');
+        if (cache?.key === key)
+            return cache.manifest;
+        const merged = { products: {} };
+        for (const entry of files) {
+            const raw = await readManifest(entry.file);
+            const product = entry.product;
+            const parsed = ProductManifestSchema.safeParse(raw);
+            if (!parsed.success || parsed.data.product !== product) {
+                console.error(`Agents: ${entry.file} is not the distribution manifest of ${product}.`);
+                continue;
+            }
+            // Its files are relative to the product's directory; the merged ones are relative to the channel's.
+            const versions = {};
+            for (const [version, stored] of Object.entries(parsed.data.versions))
+                versions[version] = {
+                    targets: Object.fromEntries(Object.entries(stored.targets).map(([target, file]) => [
+                        target,
+                        { ...file, file: path.posix.join(product, file.file) },
+                    ])),
+                };
+            merged.products[product] = {
+                ...(parsed.data.bin === undefined ? {} : { bin: parsed.data.bin }),
+                versions,
+            };
+        }
+        cache = { key, manifest: merged };
+        return merged;
+    };
+    const currentVersion = (stored, product) => {
+        const versions = Object.keys(stored.products[product]?.versions ?? {});
+        const pinned = config.versions?.[product];
+        if (pinned !== undefined)
+            return versions.includes(pinned) ? pinned : null;
+        return versions.sort(compareVersions).at(-1) ?? null;
+    };
+    const artifact = (stored, product, target) => {
+        const version = currentVersion(stored, product);
+        if (version === null)
+            return null;
+        const targets = stored.products[product]?.versions[version]?.targets;
+        const own = targets?.[target];
+        const entry = own ?? targets?.[UNIVERSAL_TARGET];
+        if (entry === undefined)
+            return null;
+        return {
+            product,
+            version,
+            target,
+            url: routePath(DIST_ROUTES.file, {
+                product,
+                version,
+                file: path.posix.basename(entry.file),
+            }),
+            sha256: entry.sha256,
+            size: entry.size,
+            channel,
+            ...(own === undefined ? { universal: true } : {}),
+        };
+    };
+    return {
+        channel,
+        async manifest() {
+            const stored = await load();
+            const products = {};
+            for (const product of Object.keys(stored?.products ?? {})) {
+                const version = stored && currentVersion(stored, product);
+                if (!stored || version === null)
+                    continue;
+                products[product] = {
+                    version,
+                    targets: Object.keys(stored.products[product]?.versions[version]?.targets ?? {}).sort(),
+                };
+            }
+            return { channel, products };
+        },
+        async find(product, target) {
+            const stored = await load();
+            return stored ? artifact(stored, product, target) : null;
+        },
+        async resolve(product, target) {
+            if (!DIST_PRODUCT_PATTERN.test(product))
+                throw notFound('Product');
+            if (!DIST_TARGET_PATTERN.test(target))
+                throw new ProtocolError('PLATFORM_UNSUPPORTED', `${target} is not a platform name such as darwin-arm64 or linux-x64.`);
+            const stored = await load();
+            const found = stored ? artifact(stored, product, target) : null;
+            if (found)
+                return found;
+            const version = stored ? currentVersion(stored, product) : null;
+            if (!stored || version === null)
+                throw new ProtocolError('NOT_FOUND', `This application serves no ${product} on the ${channel} channel. Build it with nocobase cli build.`);
+            const targets = Object.keys(stored.products[product]?.versions[version]?.targets ?? {}).sort();
+            throw new ProtocolError('PLATFORM_UNSUPPORTED', `${product} ${version} is not built for ${target}; it is for ${targets.join(', ') || 'no platform'}.`, { targets });
+        },
+        async file(product, version, name) {
+            const stored = await load();
+            const targets = stored?.products[product]?.versions[version]?.targets;
+            const found = Object.entries(targets ?? {}).find(([, candidate]) => path.posix.basename(candidate.file) === name);
+            if (!found || channelDir === null)
+                throw notFound('File');
+            const [target, entry] = found;
+            const file = path.resolve(channelDir, entry.file);
+            if (!file.startsWith(`${path.resolve(channelDir, product)}${path.sep}`))
+                throw notFound('File');
+            let size;
+            try {
+                size = (await stat(file)).size;
+            }
+            catch {
+                throw notFound('File');
+            }
+            return {
+                target,
+                path: file,
+                sha256: entry.sha256,
+                size,
+                open: () => createReadStream(file),
+            };
+        },
+        async npmPackage(product) {
+            const source = npmSources[product];
+            if (source === undefined)
+                return null;
+            const stored = await load();
+            if (stored && currentVersion(stored, product) !== null)
+                return null;
+            return {
+                kind: 'npm',
+                product,
+                version: source.version,
+                package: source.package,
+                channel,
+            };
+        },
+    };
+}
+/** `agents.dist.npm`, checked when the service is created so a wrong entry fails the start rather than an install. */
+function parseNpmSources(npm) {
+    const parsed = DistNpmConfigSchema.safeParse(npm ?? {});
+    if (!parsed.success)
+        throw new Error(`agents.dist.npm names each product's npm package and exact version, such as { nocobase-runner: { package: '@nocobase/agent-runner', version: '1.0.0' } }: ${parsed.error.issues
+            .map((issue) => `${issue.path.join('.')}: ${issue.message}`)
+            .join('; ')}`);
+    return parsed.data;
+}
+//# sourceMappingURL=artifacts.js.map

package/dist/artifacts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"artifacts.js","sourceRoot":"","sources":["../src/artifacts.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AACH,OAAO,EAAE,gBAAgB,EAAmB,MAAM,SAAS,CAAC;AAC5D,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAC3D,OAAO,IAAI,MAAM,WAAW,CAAC;AAE7B,OAAO,EACL,eAAe,EACf,oBAAoB,EACpB,WAAW,EACX,mBAAmB,EACnB,qBAAqB,EACrB,mBAAmB,EACnB,aAAa,EACb,SAAS,EAGT,gBAAgB,GAEjB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,SAAS,QAAQ,CAAC,IAAwB;IACxC,OAAO,IAAI,aAAa,CACtB,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,qBAAqB,EAChE,GAAG,IAAI,aAAa,CACrB,CAAC;AACJ,CAAC;AAyBD,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,CAClC,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,oBAAoB,CAAC,EACtC,CAAC,CAAC,MAAM,CAAC;IACP,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,mBAAmB,CAAC;IACvD,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,qBAAqB,CAAC;CACzD,CAAC,CACH,CAAC;AAEF,MAAM,CAAC,MAAM,eAAe,GAAG,QAAQ,CAAC;AAExC,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC;IAClC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACvB,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,iBAAiB,CAAC;IAC3C,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE;CACrC,CAAC,CAAC;AAEH,MAAM,oBAAoB,GAAG,CAAC,CAAC,MAAM,CACnC,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,kBAAkB,CAAC,EAAE,CAAC,CAChE,CAAC;AAEF,wHAAwH;AACxH,MAAM,qBAAqB,GAAG,CAAC,CAAC,MAAM,CAAC;IACrC,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;IACpB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,oBAAoB,CAAC;IAC/C,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC1B,QAAQ,EAAE,oBAAoB;CAC/B,CAAC,CAAC;AAsCH,MAAM,UAAU,mBAAmB,CAAC,SAAqB,EAAE;IACzD,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,IAAI,eAAe,CAAC;IAClD,MAAM,UAAU,GAAG,eAAe,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAC/C,MAAM,UAAU,GACd,MAAM,CAAC,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;IACtE,IAAI,KAA4D,CAAC;IAEjE,8FAA8F;IAC9F,MAAM,aAAa,GAAG,KAAK,IAEzB,EAAE;QACF,IAAI,UAAU,KAAK,IAAI;YAAE,OAAO,EAAE,CAAC;QACnC,MAAM,KAAK,GAAyD,EAAE,CAAC;QACvE,IAAI,OAAiB,CAAC;QACtB,IAAI,CAAC;YACH,OAAO,GAAG,CAAC,MAAM,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QAC/C,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,KAAK,CAAC;QACf,CAAC;QACD,KAAK,MAAM,OAAO,IAAI,OAAO,EAAE,CAAC;YAC9B,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,OAAO,CAAC;gBAAE,SAAS;YAClD,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,OAAO,EAAE,eAAe,CAAC,CAAC;YAC7D,IAAI,CAAC;gBACH,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;YACrE,CAAC;YAAC,MAAM,CAAC;gBACP,2BAA2B;YAC7B,CAAC;QACH,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC,CAAC;IAEF,MAAM,YAAY,GAAG,KAAK,EAAE,IAAY,EAAoB,EAAE;QAC5D,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAY,CAAC;QAC7D,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,SAAS,CAAC;QACnB,CAAC;IACH,CAAC,CAAC;IAEF,MAAM,IAAI,GAAG,KAAK,IAAoC,EAAE;QACtD,MAAM,KAAK,GAAG,MAAM,aAAa,EAAE,CAAC;QACpC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACvB,KAAK,GAAG,SAAS,CAAC;YAClB,OAAO,IAAI,CAAC;QACd,CAAC;QACD,MAAM,GAAG,GAAG,KAAK;aACd,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;aAChD,IAAI,CAAC,GAAG,CAAC,CAAC;QACb,IAAI,KAAK,EAAE,GAAG,KAAK,GAAG;YAAE,OAAO,KAAK,CAAC,QAAQ,CAAC;QAC9C,MAAM,MAAM,GAAmB,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC;QAChD,KAAK,MAAM,KAAK,IAAI,KAAK,EAAE,CAAC;YAC1B,MAAM,GAAG,GAAG,MAAM,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAC3C,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;YAC9B,MAAM,MAAM,GAAG,qBAAqB,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;YACpD,IAAI,CAAC,MAAM,CAAC,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,KAAK,OAAO,EAAE,CAAC;gBACvD,OAAO,CAAC,KAAK,CACX,WAAW,KAAK,CAAC,IAAI,wCAAwC,OAAO,GAAG,CACxE,CAAC;gBACF,SAAS;YACX,CAAC;YACD,oGAAoG;YACpG,MAAM,QAAQ,GAAmD,EAAE,CAAC;YACpE,KAAK,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC;gBAClE,QAAQ,CAAC,OAAO,CAAC,GAAG;oBAClB,OAAO,EAAE,MAAM,CAAC,WAAW,CACzB,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC;wBACrD,MAAM;wBACN,EAAE,GAAG,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,EAAE;qBACvD,CAAC,CACH;iBACF,CAAC;YACJ,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG;gBACzB,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;gBAClE,QAAQ;aACT,CAAC;QACJ,CAAC;QACD,KAAK,GAAG,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC;QAClC,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC;IAEF,MAAM,cAAc,GAAG,CACrB,MAAsB,EACtB,OAAe,EACA,EAAE;QACjB,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,QAAQ,IAAI,EAAE,CAAC,CAAC;QACvE,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,CAAC;QAC1C,IAAI,MAAM,KAAK,SAAS;YAAE,OAAO,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC;QAC3E,OAAO,QAAQ,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC;IACvD,CAAC,CAAC;IAEF,MAAM,QAAQ,GAAG,CACf,MAAsB,EACtB,OAAe,EACf,MAAc,EACO,EAAE;QACvB,MAAM,OAAO,GAAG,cAAc,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAChD,IAAI,OAAO,KAAK,IAAI;YAAE,OAAO,IAAI,CAAC;QAClC,MAAM,OAAO,GAAG,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;QACrE,MAAM,GAAG,GAAG,OAAO,EAAE,CAAC,MAAM,CAAC,CAAC;QAC9B,MAAM,KAAK,GAAG,GAAG,IAAI,OAAO,EAAE,CAAC,gBAAgB,CAAC,CAAC;QACjD,IAAI,KAAK,KAAK,SAAS;YAAE,OAAO,IAAI,CAAC;QACrC,OAAO;YACL,OAAO;YACP,OAAO;YACP,MAAM;YACN,GAAG,EAAE,SAAS,CAAC,WAAW,CAAC,IAAI,EAAE;gBAC/B,OAAO;gBACP,OAAO;gBACP,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC;aACtC,CAAC;YACF,MAAM,EAAE,KAAK,CAAC,MAAM;YACpB,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,OAAO;YACP,GAAG,CAAC,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SAClD,CAAC;IACJ,CAAC,CAAC;IAEF,OAAO;QACL,OAAO;QAEP,KAAK,CAAC,QAAQ;YACZ,MAAM,MAAM,GAAG,MAAM,IAAI,EAAE,CAAC;YAC5B,MAAM,QAAQ,GACZ,EAAE,CAAC;YACL,KAAK,MAAM,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,IAAI,EAAE,CAAC,EAAE,CAAC;gBAC1D,MAAM,OAAO,GAAG,MAAM,IAAI,cAAc,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;gBAC1D,IAAI,CAAC,MAAM,IAAI,OAAO,KAAK,IAAI;oBAAE,SAAS;gBAC1C,QAAQ,CAAC,OAAO,CAAC,GAAG;oBAClB,OAAO;oBACP,OAAO,EAAE,MAAM,CAAC,IAAI,CAClB,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,IAAI,EAAE,CAC3D,CAAC,IAAI,EAAE;iBACT,CAAC;YACJ,CAAC;YACD,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC;QAC/B,CAAC;QAED,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM;YACxB,MAAM,MAAM,GAAG,MAAM,IAAI,EAAE,CAAC;YAC5B,OAAO,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAC3D,CAAC;QAED,KAAK,CAAC,OAAO,CAAC,OAAO,EAAE,MAAM;YAC3B,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,OAAO,CAAC;gBAAE,MAAM,QAAQ,CAAC,SAAS,CAAC,CAAC;YACnE,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,MAAM,CAAC;gBACnC,MAAM,IAAI,aAAa,CACrB,sBAAsB,EACtB,GAAG,MAAM,4DAA4D,CACtE,CAAC;YACJ,MAAM,MAAM,GAAG,MAAM,IAAI,EAAE,CAAC;YAC5B,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;YAChE,IAAI,KAAK;gBAAE,OAAO,KAAK,CAAC;YACxB,MAAM,OAAO,GAAG,MAAM,CAAC,CAAC,CAAC,cAAc,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;YAChE,IAAI,CAAC,MAAM,IAAI,OAAO,KAAK,IAAI;gBAC7B,MAAM,IAAI,aAAa,CACrB,WAAW,EACX,8BAA8B,OAAO,WAAW,OAAO,6CAA6C,CACrG,CAAC;YACJ,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CACzB,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,IAAI,EAAE,CAC3D,CAAC,IAAI,EAAE,CAAC;YACT,MAAM,IAAI,aAAa,CACrB,sBAAsB,EACtB,GAAG,OAAO,IAAI,OAAO,qBAAqB,MAAM,eAAe,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,aAAa,GAAG,EACrG,EAAE,OAAO,EAAE,CACZ,CAAC;QACJ,CAAC;QAED,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI;YAC/B,MAAM,MAAM,GAAG,MAAM,IAAI,EAAE,CAAC;YAC5B,MAAM,OAAO,GAAG,MAAM,EAAE,QAAQ,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;YACtE,MAAM,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,IAAI,CAC9C,CAAC,CAAC,EAAE,SAAS,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,IAAI,CAChE,CAAC;YACF,IAAI,CAAC,KAAK,IAAI,UAAU,KAAK,IAAI;gBAAE,MAAM,QAAQ,CAAC,MAAM,CAAC,CAAC;YAC1D,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,GAAG,KAAK,CAAC;YAC9B,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;YAClD,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;gBACrE,MAAM,QAAQ,CAAC,MAAM,CAAC,CAAC;YACzB,IAAI,IAAY,CAAC;YACjB,IAAI,CAAC;gBACH,IAAI,GAAG,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;YACjC,CAAC;YAAC,MAAM,CAAC;gBACP,MAAM,QAAQ,CAAC,MAAM,CAAC,CAAC;YACzB,CAAC;YACD,OAAO;gBACL,MAAM;gBACN,IAAI,EAAE,IAAI;gBACV,MAAM,EAAE,KAAK,CAAC,MAAM;gBACpB,IAAI;gBACJ,IAAI,EAAE,GAAG,EAAE,CAAC,gBAAgB,CAAC,IAAI,CAAC;aACnC,CAAC;QACJ,CAAC;QAED,KAAK,CAAC,UAAU,CAAC,OAAO;YACtB,MAAM,MAAM,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;YACnC,IAAI,MAAM,KAAK,SAAS;gBAAE,OAAO,IAAI,CAAC;YACtC,MAAM,MAAM,GAAG,MAAM,IAAI,EAAE,CAAC;YAC5B,IAAI,MAAM,IAAI,cAAc,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,IAAI;gBAAE,OAAO,IAAI,CAAC;YACpE,OAAO;gBACL,IAAI,EAAE,KAAK;gBACX,OAAO;gBACP,OAAO,EAAE,MAAM,CAAC,OAAO;gBACvB,OAAO,EAAE,MAAM,CAAC,OAAO;gBACvB,OAAO;aACR,CAAC;QACJ,CAAC;KACF,CAAC;AACJ,CAAC;AAED,sHAAsH;AACtH,SAAS,eAAe,CACtB,GAAsB;IAEtB,MAAM,MAAM,GAAG,mBAAmB,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,CAAC,CAAC;IACxD,IAAI,CAAC,MAAM,CAAC,OAAO;QACjB,MAAM,IAAI,KAAK,CACb,6JAA6J,MAAM,CAAC,KAAK,CAAC,MAAM;aAC7K,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC;aAC3D,IAAI,CAAC,IAAI,CAAC,EAAE,CAChB,CAAC;IACJ,OAAO,MAAM,CAAC,IAAI,CAAC;AACrB,CAAC"}

package/dist/download-tokens.d.ts

@@ -0,0 +1,57 @@
+export interface DownloadToken {
+    readonly token: string;
+    readonly expiresAt: string;
+    readonly maxDownloads: number;
+}
+export interface Clock {
+    now(): Date;
+}
+/** How long a download token stays usable. */
+export declare const DOWNLOAD_TOKEN_TTL_MS: number;
+/** How many tarball downloads one token allows, so a failed download can be retried. */
+export declare const DOWNLOAD_TOKEN_MAX_DOWNLOADS = 3;
+export interface DownloadTokenRecord {
+    readonly id: string;
+    readonly tokenHash: string;
+    readonly createdById: string | null;
+    readonly target: string | null;
+    readonly downloads: number;
+    readonly expiresAt: string;
+    readonly createdAt: string;
+}
+/** Storage operations within the host's transaction. Updates must compare the stored download count atomically. */
+export interface DownloadTokenTransaction {
+    insert(record: DownloadTokenRecord): Promise<void>;
+    findByHash(hash: string): Promise<DownloadTokenRecord | null | undefined>;
+    updateIfDownloads(id: string, expected: number, values: {
+        target: string | null;
+        downloads: number;
+    }): Promise<boolean>;
+}
+export interface DownloadTokenStore {
+    transaction<T>(fn: (store: DownloadTokenTransaction) => Promise<T>): Promise<T>;
+}
+/** What a request with a download token asks for. */
+export interface DownloadRequest {
+    readonly product?: string;
+    /** The platform it resolves or downloads for; absent for the manifest, and for the universal tarball. */
+    readonly target?: string;
+    /** A tarball download, which counts against the token. */
+    readonly download?: boolean;
+}
+export interface DownloadTokenService {
+    create(createdById: string | null): Promise<DownloadToken>;
+    /** Lets `request` through with `token`, binding its platform and counting a download; `DOWNLOAD_TOKEN_INVALID` otherwise. */
+    admit(token: string, request: DownloadRequest): Promise<void>;
+}
+export interface DownloadTokenServiceDeps {
+    /** The one product a download token downloads: the application's CLI (`agents.cli.name`). */
+    readonly product: string;
+    readonly store: DownloadTokenStore;
+    readonly ids: {
+        next(): string;
+    };
+    readonly clock: Clock;
+}
+export declare function createDownloadTokenService(deps: DownloadTokenServiceDeps): DownloadTokenService;
+//# sourceMappingURL=download-tokens.d.ts.map

package/dist/download-tokens.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"download-tokens.d.ts","sourceRoot":"","sources":["../src/download-tokens.ts"],"names":[],"mappings":"AAIA,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;CAC/B;AACD,MAAM,WAAW,KAAK;IACpB,GAAG,IAAI,IAAI,CAAC;CACb;AACD,8CAA8C;AAC9C,eAAO,MAAM,qBAAqB,EAAE,MAAoB,CAAC;AAEzD,wFAAwF;AACxF,eAAO,MAAM,4BAA4B,IAAI,CAAC;AAE9C,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IACpC,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;CAC5B;AAED,mHAAmH;AACnH,MAAM,WAAW,wBAAwB;IACvC,MAAM,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACnD,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,GAAG,IAAI,GAAG,SAAS,CAAC,CAAC;IAC1E,iBAAiB,CACf,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE;QAAE,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE,GACnD,OAAO,CAAC,OAAO,CAAC,CAAC;CACrB;AACD,MAAM,WAAW,kBAAkB;IACjC,WAAW,CAAC,CAAC,EACX,EAAE,EAAE,CAAC,KAAK,EAAE,wBAAwB,KAAK,OAAO,CAAC,CAAC,CAAC,GAClD,OAAO,CAAC,CAAC,CAAC,CAAC;CACf;AAED,qDAAqD;AACrD,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,yGAAyG;IACzG,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,0DAA0D;IAC1D,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED,MAAM,WAAW,oBAAoB;IACnC,MAAM,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IAC3D,6HAA6H;IAC7H,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC/D;AAED,MAAM,WAAW,wBAAwB;IACvC,6FAA6F;IAC7F,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,KAAK,EAAE,kBAAkB,CAAC;IACnC,QAAQ,CAAC,GAAG,EAAE;QAAE,IAAI,IAAI,MAAM,CAAA;KAAE,CAAC;IACjC,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;CACvB;AAED,wBAAgB,0BAA0B,CACxC,IAAI,EAAE,wBAAwB,GAC7B,oBAAoB,CAsEtB"}