@foir/sdk 0.21.0 → 0.23.0

package/dist/transport/foir-http.d.ts

@@ -11,7 +11,7 @@
  *
  * The split exists so the second one is possible. The Foir-specific transport
  * concerns — which api key is in play, the preview schema channel header, the
- * optional customer bearer, and the `FoirRequestError` shape — are identical on
+ * optional user bearer, and the `FoirRequestError` shape — are identical on
  * both, and duplicating them is exactly how the two surfaces would drift. So
  * they live here once and `foir-request.ts` re-exports them unchanged; the only
  * thing that stayed behind is the part that needs `print`.
@@ -31,7 +31,7 @@ export interface FoirEnv {
  *
  * Preview is selected at the environment level, not per-request: load a
  * preview env file that sets `FOIR_PREVIEW=true` + the preview environment's
- * own `pk_…` key holding `drafts:read` as `PLATFORM_PREVIEW_API_KEY`, instead
+ * own publishable key holding `drafts:read` as `PLATFORM_PREVIEW_API_KEY`, instead
  * of the default env.
  * The site-wide mode keeps draft semantics consistent — every loader sees
  * the same preview/published view of the world. Intended for non-production
@@ -206,8 +206,8 @@ export declare function readFoirRateLimit(headers: Headers): FoirRateLimitSnapsh
 export declare function readFoirRetryAfterMs(headers: Headers): number | undefined;
 export interface FoirRequestOptions {
     /**
-     * Customer bearer token. api-public still needs the `x-api-key` to resolve
-     * the project; the bearer adds the customer identity for self-scoped reads
+     * User bearer token. api-public still needs the `x-api-key` to resolve
+     * the project; the bearer adds the user identity for self-scoped reads
      * (e.g. `myProfile`). Used by `@foir/sdk/auth`'s post-login profile fetch.
      */
     bearerToken?: string;
@@ -256,7 +256,7 @@ export interface FoirRequestOptions {
     onRateLimit?: (snapshot: FoirRateLimitSnapshot | undefined) => void;
 }
 /**
- * Supplies the current customer bearer. Sync or async so consumers can read a
+ * Supplies the current user bearer. Sync or async so consumers can read a
  * cookie session (Hydrogen/Remix), a KV store, an in-memory value, etc. Returns
  * the token when signed in, or `null`/`undefined` when signed out.
  *
@@ -265,7 +265,7 @@ export interface FoirRequestOptions {
  * they would end up accepting subtly different things.
  */
 export type FoirTokenProvider = () => string | null | undefined | Promise<string | null | undefined>;
-/** A request made with an api key, optionally for a signed-in customer. */
+/** A request made with an api key, optionally for a signed-in user. */
 export interface FoirKeyHeaderInput {
     apiKey: string;
     /**
@@ -305,7 +305,7 @@ export interface FoirKeyHeaderInput {
  *
  * The token is the whole credential. api-public takes the scoped path when
  * `X-Foir-Token` is present and never reads `x-api-key` on it, and the
- * organization, the customer and the schema channel all come from the token's
+ * organization, the user and the schema channel all come from the token's
  * own claims, so none of the key-side inputs has anything to say here.
  */
 export interface FoirDispatchHeaderInput {
@@ -337,7 +337,7 @@ export declare function refuseCredentialHeaders(extra: Readonly<Record<string, s
  * authorization difference nobody would notice until it mattered.
  *
  * Two credentials, and a request carries exactly one: an api key (with its
- * optional customer bearer, organization and channel), or an operation's
+ * optional user bearer, organization and channel), or an operation's
  * dispatch token. A dispatch request never writes `x-api-key`.
  */
 /** The header a server names the visitor it calls for in. */
@@ -412,7 +412,7 @@ export declare function foirApiEndpoint(apiUrl: string, path: `/${string}`): str
 /**
  * Foir DISCARDED a credential you sent, and served the request without it.
  *
- * A customer JWT is optional: if it fails to verify, the read is served as an
+ * A user JWT is optional: if it fails to verify, the read is served as an
  * ordinary anonymous one rather than refused, because plenty of reads
  * legitimately have nobody signed in. That is the right behaviour and it has a
  * sharp edge — a lapsed token and a genuinely anonymous request produce the
@@ -424,9 +424,9 @@ export declare function foirApiEndpoint(apiUrl: string, path: `/${string}`): str
  */
 export interface FoirAuthDowngrade {
     /** Always `"rejected"`. */
-    customerToken: string;
+    userToken: string;
     /**
-     * `expired` — re-exchange and retry. `invalid` — not a customer token for
+     * `expired` — re-exchange and retry. `invalid` — not a user token for
      * this environment. `wrong_project` — the token and the api-key name
      * different projects.
      */
@@ -435,7 +435,7 @@ export interface FoirAuthDowngrade {
     servedAs: string;
 }
 /**
- * A request that sent a customer token was served without it.
+ * A request that sent a user token was served without it.
  *
  * Thrown only to a caller that asked (`rejectDowngrade`): one that sent the
  * token because it wants the signed-in answer, and would otherwise be handed the
@@ -448,9 +448,9 @@ export declare class FoirAuthDowngradedError extends FoirRequestError {
     constructor(downgrade: FoirAuthDowngrade);
 }
 /**
- * The customer's session is over: its token was rejected and could not be
+ * The user's session is over: its token was rejected and could not be
  * refreshed. It is what a signed-in request gets in place of the anonymous
- * answer. Send the customer to sign in again.
+ * answer. Send the user to sign in again.
  */
 export declare class FoirSessionExpiredError extends FoirRequestError {
     constructor(options?: {

package/dist/transport/key-kind.d.ts

@@ -6,30 +6,19 @@
  * app's pages. An admin key is a machine's own: a sync job, a pipeline, a tool.
  * A key says its kind in its first letters, so this is decided without a
  * request.
- *
- * A key minted before a key had a kind says an older type. A `pk_` key is a
- * publishable key. An `sk_` or a `tc_` key says only that it is not public:
- * the platform holds it as an admin key, and it is reported here as `older`,
- * so that a caller who refuses an admin key by name does not refuse a key
- * whose holder has not yet been able to mint a server key in its place.
  */
 export type FoirKeyKind = 'publishable' | 'server' | 'admin';
-/** What a key's prefix says of it: its kind, or that it is an older secret. */
-export type FoirKeyPrefixKind = FoirKeyKind | 'older';
 /** Where each credential is for, and which key an app holds. */
 export declare const FOIR_CREDENTIALS_DOC = "https://docs.foir.dev/credentials";
 /**
  * What a key says of itself by its prefix, or `undefined` for a string that
  * is no key Fóir made.
  */
-export declare function foirKeyKind(apiKey: string | null | undefined): FoirKeyPrefixKind | undefined;
+export declare function foirKeyKind(apiKey: string | null | undefined): FoirKeyKind | undefined;
 /**
  * What an app's client says when it is handed an admin key, naming the client
  * it was handed to. An admin key is a machine's own, so every client an app
  * builds refuses one before any request, in the same words.
- *
- * Only a key that says it is an admin key by its prefix is refused. A key
- * minted before a key had a kind does not say, and is let through.
  */
 export declare function adminKeyRefusal(client: string): string;
 /**

package/dist/types/index.d.ts

@@ -21,7 +21,7 @@ export interface EditorInit {
     apiUrl: string;
     /** Config connection domain (e.g. my-store.myshopify.com) */
     connectionDomain?: string;
-    /** How this editor is rendered in the admin UI. */
+    /** How this editor is rendered in the console. */
     configMode?: 'editor' | 'sidebar';
     /** Currently selected field keys (sidebar mode). */
     selectedFieldKeys?: string[];
@@ -67,7 +67,7 @@ export interface EditorContextValue {
     resize: (height: number) => void;
     /** Report dirty state (unsaved changes). */
     setDirty: (isDirty: boolean) => void;
-    /** Request the host to navigate to an admin path. */
+    /** Request the host to navigate to a console path. */
     requestNavigate: (path: string) => void;
     /** Request the host to execute a platform operation. Returns the result.
      * `mode` controls whether the platform waits for the operation to complete

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@foir/sdk",
-  "version": "0.21.0",
+  "version": "0.23.0",
   "description": "Official Foir SDK — editor iframe client + server-side platform helpers",
   "type": "module",
   "publishConfig": {