@sheetxl/sdk 0.8.0-beta.2 → 0.8.0-beta.4

package/types/scripting.d.ts

@@ -97,11 +97,14 @@ declare global {
     /**
      * Add a resource ROOT, searched ahead of anything the packages ship.
      *
-     * Re-declared here rather than re-exported straight from the seam, because a
-     * `export { x } from '@sheetxl/utils/resource'` survives type emit into `LocaleResource.d.ts` — and
-     * that subpath does not exist in the published `package.json`, so every consumer of this package's
-     * types got TS2307. Note sdk gets away with the same seam only because it never re-exports a symbol
-     * out of one; keep it that way here.
+     * In the browser this is required to load anything beyond the bundled default language — there is
+     * no implicit root. An app that stages resources with `ResourcesPlugin` (or `stageResources`) serves
+     * them at `/resources`, so it calls `addResourceRoot('/resources')`.
+     *
+     * May be called before or after packages load; already-registered packages re-discover their locales.
+     *
+     * @param root a URL prefix (browser) or directory (node) laid out as `<root>/<kind>/<pkg>/<relPath>`,
+     *             or a custom {@link ResourceRoot}.
      */
     export function addResourceRoot(root: string | ResourceRoot): void;
 
@@ -2235,8 +2238,8 @@ declare global {
      */
     export function getLocaleProfile(tag: string, overrides?: LocaleProfileOverrides | null): LocaleProfile;
 
-    /** The current base (the browser default when unset). */
-    export function getLocaleResourceBase(): string;
+    /** The configured base, or `null` when none has been set. */
+    export function getLocaleResourceBase(): string | null;
 
     export function getScriptingApi(): Promise<ScriptingApi.Index>;
 
@@ -33843,6 +33846,7 @@ declare global {
     export interface LicenseDetails {
         getLicensee(): string | null;
         getExpiration(): Date | null;
+        getRuntimes(): ('browser' | 'server')[];
         getDomains(): string[];
         getCpuCount(): number;
         getMemory(): number;
@@ -33914,12 +33918,25 @@ declare global {
      */
     export function listLocaleResources(pkg: string, fromUrl?: string): Promise<ResourceIndex[]>;
 
+    /**
+     * List the resource indexes published for a package under a resource kind.
+     *
+     * @param kind The resource namespace, such as `'locales'` or `'templates'`.
+     * @param pkg The package the resources belong to.
+     * @param base A base to search after the user resource roots, or `null` for none.
+     * @param fromUrl Node only. The `import.meta.url` to locate the package's own resources from.
+     */
+    export function listResources(kind: string, pkg: string, base: string | null, fromUrl?: string): Promise<ResourceIndex[]>;
+
     export class LM {
         constructor();
         /**
          * Set the license key provided by SheetXL.
          * @remarks
-         * The license key can also be provided via a file named `sheetxl.lic` in the root of the web server.
+         * Without a call to this, the key is looked for where it runs:
+         * - In a browser, a file named `sheetxl.lic` served beside the page.
+         * - Outside a browser (Node, Bun, Deno, CI), the `SHEETXL_LICENSE_KEY` environment variable, then
+         *   the key saved by `sheetxl license activate`.
          *
          * @param licenseKey The license key as a string.
          * @param force If set to `true` will replace an existing key.
@@ -34674,6 +34691,13 @@ declare global {
         [K in keyof T]: Required<Pick<T, K>> & Partial<Record<Exclude<keyof T, K>, never>>;
     }[keyof T];
 
+    /**
+     * Listen for the set of places resources are loaded from changing — a root added or the base set.
+     *
+     * Locale discovery subscribes to this so a root added after a package registered still contributes.
+     */
+    export function onResourceRootsChange(listener: () => void): RemoveListener;
+
     export interface OrientationFlags {
         vertical: boolean;
         horizontal: boolean;
@@ -35387,7 +35411,7 @@ declare global {
     export function resolveLocaleChain(tag: string, locales: Record<string, LocaleIndexEntry | undefined>): string[];
 
     /**
-     * Resolve a locale resource URL: `<base><pkg>/<relPath>`.
+     * Resolve a locale resource URL: `<base><pkg>/<relPath>`, or `null` when no base is configured.
      *
      * Browser-shaped, and only describes the BASE — it does not account for resource roots, which may
      * outrank it. Use {@link fetchLocaleResource} to actually load.
@@ -35395,7 +35419,7 @@ declare global {
      * @param pkg     the owning package id, e.g. `'@sheetxl/react'`
      * @param relPath the path within that package's `locales/`, e.g. `'de/model.msg.json'` or `'inherit.json'`
      */
-    export function resolveLocaleResource(pkg: string, relPath: string): string;
+    export function resolveLocaleResource(pkg: string, relPath: string): string | null;
 
     /**
      * The log timeout in effect, in milliseconds: the first candidate that is a non-negative number,
@@ -35779,7 +35803,7 @@ declare global {
     /**
      * Set the base under which package locale resources are served.
      *
-     * In the browser this is a URL prefix (default `'/resources/locales/'`). In node it is a DIRECTORY.
+     * In the browser this is a URL prefix, e.g. `'/resources/locales/'`. In node it is a DIRECTORY.
      * Unlike a resource ROOT it names the kind itself, so it holds `<pkg>/<relPath>` directly with no
      * `locales/` segment — leave it unset in node unless the host stages the files that way.
      */

package/types/src/lib/utils/utils.browser.d.ts

@@ -21,6 +21,11 @@ export declare function getLocation(): string;
  * The OS platform, used by the `INFO("system")` formula.
  */
 export declare function getOS(): string;
+/**
+ * The key in a `sheetxl.lic` served beside the page: its first line that is not blank or a `#`
+ * comment. A server that answers every path with its app page (a single-page app's fallback) sends
+ * HTML with a 200, so an HTML response is no key rather than an invalid one.
+ */
 export declare function findLicenseKey(): Promise<{
     key: string;
     from: string;

package/types/src/license/LicenseDetails.d.ts

@@ -4,6 +4,7 @@
 export interface LicenseDetails {
     getLicensee(): string | null;
     getExpiration(): Date | null;
+    getRuntimes(): ('browser' | 'server')[];
     getDomains(): string[];
     getCpuCount(): number;
     getMemory(): number;

package/types/src/license/LicenseManager.d.ts

@@ -4,7 +4,10 @@ declare class LM {
     /**
      * Set the license key provided by SheetXL.
      * @remarks
-     * The license key can also be provided via a file named `sheetxl.lic` in the root of the web server.
+     * Without a call to this, the key is looked for where it runs:
+     * - In a browser, a file named `sheetxl.lic` served beside the page.
+     * - Outside a browser (Node, Bun, Deno, CI), the `SHEETXL_LICENSE_KEY` environment variable, then
+     *   the key saved by `sheetxl license activate`.
      *
      * @param licenseKey The license key as a string.
      * @param force If set to `true` will replace an existing key.

package/types/src/license/license-key.d.ts

@@ -1,15 +1,30 @@
 import { LicenseDetails } from './LicenseDetails';
+/**
+ * Where a license runs. `browser` is any page (checked against its origin); `server` is any
+ * JavaScript runtime outside a browser - Node, Bun, Deno, the CLI, a CI runner (checked against the
+ * machine).
+ */
+export type LicenseRuntime = 'browser' | 'server';
+export declare const LICENSE_RUNTIMES: readonly LicenseRuntime[];
 export interface Decoded {
     licensee?: string | null;
     type?: string;
     expiry?: number;
     developerCount?: number;
+    /** The runtimes the key covers; `undefined` for a key issued before runtimes were explicit. */
+    runtimes?: LicenseRuntime[];
     domains?: string[];
     fingerprint?: string | null;
     cpuCount?: number;
     memory?: number | null;
     features?: Record<string, any>[];
 }
+/**
+ * The runtimes a decoded key covers. A key issued before runtimes were explicit covers `browser`
+ * when it has origins, and `server` unless its cpu and memory are both 0 (the old browser-only
+ * marker).
+ */
+export declare function getRuntimes(decoded: Decoded): LicenseRuntime[];
 export interface LicenseAndKey {
     details: LicenseDetails;
     key: string;
@@ -19,6 +34,11 @@ export interface LicenseKeyDetails {
     type?: string;
     expiration?: string | null;
     developerCount?: number;
+    /**
+     * The runtimes the key covers. Defaults to what the other terms imply: `browser` when there are
+     * origins, `server` when there is a fingerprint, cpu count or memory.
+     */
+    runtimes?: LicenseRuntime[] | null;
     /** Licensed origins, `<protocol>://<host>` each (see `Origin`); a string is comma-separated. */
     domains?: string | string[];
     fingerprint?: string | null;

package/browser/cjs/4f5eoQQfV-V7LO2_.cjs

@@ -1 +0,0 @@
-const e=require("./KWQPie2u7AP69web.cjs");exports.initializeFunctions=e.R;