@skillcdn/console 0.1.1 → 0.1.3

package/dist/routes.d.ts

@@ -1,23 +1,20 @@
 import type { ProviderKey } from "./vocabulary.js";
-/** One prefix per resource; an id follows where one is needed. */
+/** One prefix per resource of the workspace; an id follows where one is needed. */
 export declare const REST_ROUTES: {
     /** Who is signed in, what the workspace is called, and whether anyone can sign in. */
     readonly me: "/api/v1/me";
     /** The people of the workspace: everyone who has signed in. */
     readonly people: "/api/v1/people";
-    readonly tasks: "/api/v1/tasks";
-    readonly decisions: "/api/v1/decisions";
-    /** The feed, from a point on; and `/stream` under it, the same as it happens. */
+    /** The projects the asker may see; the board of each is under its key. */
+    readonly projects: "/api/v1/projects";
+    /** The workspace's own events, the ones about no project: who joined, who was made what. */
     readonly events: "/api/v1/events";
     /** The tokens of whoever asks: what their agents, scripts and consoles act as them with. */
     readonly tokens: "/api/v1/tokens";
-    /** The runs: agents at work, and what they did. */
-    readonly runs: "/api/v1/runs";
-    /** The bytes of a file a run handed in: `/api/v1/files/<artifact id>`. */
-    readonly files: "/api/v1/files";
-    /** The organization's skills, as SkillCDN serves them at the console's address. */
-    readonly skills: "/api/v1/skills";
 };
+/** What a project holds, each under `/api/v1/projects/<key>/<collection>`. */
+export declare const PROJECT_COLLECTIONS: readonly ["tasks", "decisions", "runs", "files", "events", "skills", "members", "docs"];
+export type ProjectCollection = (typeof PROJECT_COLLECTIONS)[number];
 /** Where a browser signs in and out. Signing in is per provider: `/auth/<provider>/...`. */
 export declare const AUTH_ROUTES: {
     /** Sends the browser to the provider to sign in, and afterwards to `return_to`. */
@@ -42,6 +39,13 @@ export declare function isSignInFailure(value: string | null | undefined): value
 export declare function loginPath(provider: ProviderKey, returnTo: string): string;
 /** A page of this origin, told why the sign-in it was waiting for did not complete. */
 export declare function signInPath(page: string, failure: SignInFailure): string;
-/** The REST path of one task, decision, token, person, run or file: the collection, then the id. */
-export declare function restPath(collection: "tasks" | "decisions" | "tokens" | "people" | "runs" | "files", id: string): string;
+/** The REST path of one person, token or project: the collection, then the id or the key. */
+export declare function restPath(collection: "people" | "tokens" | "projects", id: string): string;
+/**
+ * The REST path of a project, of one of its collections, or of one item in it: the tasks of
+ * `web` are at `projectPath("web", "tasks")`, task 7 at `projectPath("web", "tasks", "7")`.
+ * A document's path is one segment of the URL, its slashes encoded: `projectPath("web",
+ * "docs", "guides/onboarding")` is `/api/v1/projects/web/docs/guides%2Fonboarding`.
+ */
+export declare function projectPath(key: string, collection?: ProjectCollection, id?: string): string;
 //# sourceMappingURL=routes.d.ts.map

package/dist/routes.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"routes.d.ts","sourceRoot":"","sources":["../src/routes.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAEnD,kEAAkE;AAClE,eAAO,MAAM,WAAW;IACtB,sFAAsF;aACtF,EAAE,EAAE,YAAY;IAChB,+DAA+D;aAC/D,MAAM,EAAE,gBAAgB;aACxB,KAAK,EAAE,eAAe;aACtB,SAAS,EAAE,mBAAmB;IAC9B,iFAAiF;aACjF,MAAM,EAAE,gBAAgB;IACxB,4FAA4F;aAC5F,MAAM,EAAE,gBAAgB;IACxB,mDAAmD;aACnD,IAAI,EAAE,cAAc;IACpB,0EAA0E;aAC1E,KAAK,EAAE,eAAe;IACtB,mFAAmF;aACnF,MAAM,EAAE,gBAAgB;CAChB,CAAC;AAEX,4FAA4F;AAC5F,eAAO,MAAM,WAAW;IACtB,mFAAmF;aACnF,KAAK,aAAa,WAAW,KAAG,MAAM;IACtC,oDAAoD;aACpD,QAAQ,aAAa,WAAW,KAAG,MAAM;IACzC,mDAAmD;aACnD,MAAM,EAAE,cAAc;CACd,CAAC;AAEX,+FAA+F;AAC/F,eAAO,MAAM,eAAe,cAAc,CAAC;AAE3C;;;;GAIG;AACH,eAAO,MAAM,aAAa,YAAY,CAAC;AACvC,eAAO,MAAM,gBAAgB,YAAI,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,CAAU,CAAC;AACpF,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,gBAAgB,CAAC,CAAC,MAAM,CAAC,CAAC;AAE9D,wBAAgB,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,KAAK,IAAI,aAAa,CAExF;AAED,sFAAsF;AACtF,wBAAgB,SAAS,CAAC,QAAQ,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAEzE;AAED,uFAAuF;AACvF,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,GAAG,MAAM,CAEvE;AAED,oGAAoG;AACpG,wBAAgB,QAAQ,CACtB,UAAU,EAAE,OAAO,GAAG,WAAW,GAAG,QAAQ,GAAG,QAAQ,GAAG,MAAM,GAAG,OAAO,EAC1E,EAAE,EAAE,MAAM,GACT,MAAM,CAER"}
+{"version":3,"file":"routes.d.ts","sourceRoot":"","sources":["../src/routes.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAEnD,mFAAmF;AACnF,eAAO,MAAM,WAAW;IACtB,sFAAsF;aACtF,EAAE,EAAE,YAAY;IAChB,+DAA+D;aAC/D,MAAM,EAAE,gBAAgB;IACxB,0EAA0E;aAC1E,QAAQ,EAAE,kBAAkB;IAC5B,4FAA4F;aAC5F,MAAM,EAAE,gBAAgB;IACxB,4FAA4F;aAC5F,MAAM,EAAE,gBAAgB;CAChB,CAAC;AAEX,8EAA8E;AAC9E,eAAO,MAAM,mBAAmB,YAC9B,OAAO,EACP,WAAW,EACX,MAAM,EACN,OAAO,EACP,QAAQ,EACR,QAAQ,EACR,SAAS,EACT,MAAM,CACE,CAAC;AAEX,MAAM,MAAM,iBAAiB,GAAG,CAAC,OAAO,mBAAmB,CAAC,CAAC,MAAM,CAAC,CAAC;AAErE,4FAA4F;AAC5F,eAAO,MAAM,WAAW;IACtB,mFAAmF;aACnF,KAAK,aAAa,WAAW,KAAG,MAAM;IACtC,oDAAoD;aACpD,QAAQ,aAAa,WAAW,KAAG,MAAM;IACzC,mDAAmD;aACnD,MAAM,EAAE,cAAc;CACd,CAAC;AAEX,+FAA+F;AAC/F,eAAO,MAAM,eAAe,cAAc,CAAC;AAE3C;;;;GAIG;AACH,eAAO,MAAM,aAAa,YAAY,CAAC;AACvC,eAAO,MAAM,gBAAgB,YAAI,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,CAAU,CAAC;AACpF,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,gBAAgB,CAAC,CAAC,MAAM,CAAC,CAAC;AAE9D,wBAAgB,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,KAAK,IAAI,aAAa,CAExF;AAED,sFAAsF;AACtF,wBAAgB,SAAS,CAAC,QAAQ,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAEzE;AAED,uFAAuF;AACvF,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,GAAG,MAAM,CAEvE;AAED,6FAA6F;AAC7F,wBAAgB,QAAQ,CAAC,UAAU,EAAE,QAAQ,GAAG,QAAQ,GAAG,UAAU,EAAE,EAAE,EAAE,MAAM,GAAG,MAAM,CAEzF;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,iBAAiB,EAAE,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAQ5F"}

package/dist/routes.js

@@ -1,22 +1,27 @@
-/** One prefix per resource; an id follows where one is needed. */
+/** One prefix per resource of the workspace; an id follows where one is needed. */
 export const REST_ROUTES = {
     /** Who is signed in, what the workspace is called, and whether anyone can sign in. */
     me: "/api/v1/me",
     /** The people of the workspace: everyone who has signed in. */
     people: "/api/v1/people",
-    tasks: "/api/v1/tasks",
-    decisions: "/api/v1/decisions",
-    /** The feed, from a point on; and `/stream` under it, the same as it happens. */
+    /** The projects the asker may see; the board of each is under its key. */
+    projects: "/api/v1/projects",
+    /** The workspace's own events, the ones about no project: who joined, who was made what. */
     events: "/api/v1/events",
     /** The tokens of whoever asks: what their agents, scripts and consoles act as them with. */
     tokens: "/api/v1/tokens",
-    /** The runs: agents at work, and what they did. */
-    runs: "/api/v1/runs",
-    /** The bytes of a file a run handed in: `/api/v1/files/<artifact id>`. */
-    files: "/api/v1/files",
-    /** The organization's skills, as SkillCDN serves them at the console's address. */
-    skills: "/api/v1/skills",
 };
+/** What a project holds, each under `/api/v1/projects/<key>/<collection>`. */
+export const PROJECT_COLLECTIONS = [
+    "tasks",
+    "decisions",
+    "runs",
+    "files",
+    "events",
+    "skills",
+    "members",
+    "docs",
+];
 /** Where a browser signs in and out. Signing in is per provider: `/auth/<provider>/...`. */
 export const AUTH_ROUTES = {
     /** Sends the browser to the provider to sign in, and afterwards to `return_to`. */
@@ -46,8 +51,23 @@ export function loginPath(provider, returnTo) {
 export function signInPath(page, failure) {
     return `${page}${page.includes("?") ? "&" : "?"}${SIGN_IN_PARAM}=${failure}`;
 }
-/** The REST path of one task, decision, token, person, run or file: the collection, then the id. */
+/** The REST path of one person, token or project: the collection, then the id or the key. */
 export function restPath(collection, id) {
     return `${REST_ROUTES[collection]}/${encodeURIComponent(id)}`;
 }
+/**
+ * The REST path of a project, of one of its collections, or of one item in it: the tasks of
+ * `web` are at `projectPath("web", "tasks")`, task 7 at `projectPath("web", "tasks", "7")`.
+ * A document's path is one segment of the URL, its slashes encoded: `projectPath("web",
+ * "docs", "guides/onboarding")` is `/api/v1/projects/web/docs/guides%2Fonboarding`.
+ */
+export function projectPath(key, collection, id) {
+    const base = restPath("projects", key);
+    if (collection === undefined) {
+        return base;
+    }
+    return id === undefined
+        ? `${base}/${collection}`
+        : `${base}/${collection}/${encodeURIComponent(id)}`;
+}
 //# sourceMappingURL=routes.js.map

package/dist/routes.js.map

@@ -1 +1 @@
-{"version":3,"file":"routes.js","sourceRoot":"","sources":["../src/routes.ts"],"names":[],"mappings":"AAIA,kEAAkE;AAClE,MAAM,CAAC,MAAM,WAAW,GAAG;IACzB,sFAAsF;IACtF,EAAE,EAAE,YAAY;IAChB,+DAA+D;IAC/D,MAAM,EAAE,gBAAgB;IACxB,KAAK,EAAE,eAAe;IACtB,SAAS,EAAE,mBAAmB;IAC9B,iFAAiF;IACjF,MAAM,EAAE,gBAAgB;IACxB,4FAA4F;IAC5F,MAAM,EAAE,gBAAgB;IACxB,mDAAmD;IACnD,IAAI,EAAE,cAAc;IACpB,0EAA0E;IAC1E,KAAK,EAAE,eAAe;IACtB,mFAAmF;IACnF,MAAM,EAAE,gBAAgB;CAChB,CAAC;AAEX,4FAA4F;AAC5F,MAAM,CAAC,MAAM,WAAW,GAAG;IACzB,mFAAmF;IACnF,KAAK,EAAE,CAAC,QAAqB,EAAU,EAAE,CAAC,SAAS,QAAQ,QAAQ;IACnE,oDAAoD;IACpD,QAAQ,EAAE,CAAC,QAAqB,EAAU,EAAE,CAAC,SAAS,QAAQ,WAAW;IACzE,mDAAmD;IACnD,MAAM,EAAE,cAAc;CACd,CAAC;AAEX,+FAA+F;AAC/F,MAAM,CAAC,MAAM,eAAe,GAAG,WAAW,CAAC;AAE3C;;;;GAIG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,SAAS,CAAC;AACvC,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,CAAU,CAAC;AAGpF,MAAM,UAAU,eAAe,CAAC,KAAgC;IAC9D,OAAQ,gBAAsC,CAAC,QAAQ,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC;AACvE,CAAC;AAED,sFAAsF;AACtF,MAAM,UAAU,SAAS,CAAC,QAAqB,EAAE,QAAgB;IAC/D,OAAO,GAAG,WAAW,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,eAAe,IAAI,kBAAkB,CAAC,QAAQ,CAAC,EAAE,CAAC;AAC7F,CAAC;AAED,uFAAuF;AACvF,MAAM,UAAU,UAAU,CAAC,IAAY,EAAE,OAAsB;IAC7D,OAAO,GAAG,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,aAAa,IAAI,OAAO,EAAE,CAAC;AAC/E,CAAC;AAED,oGAAoG;AACpG,MAAM,UAAU,QAAQ,CACtB,UAA0E,EAC1E,EAAU;IAEV,OAAO,GAAG,WAAW,CAAC,UAAU,CAAC,IAAI,kBAAkB,CAAC,EAAE,CAAC,EAAE,CAAC;AAChE,CAAC"}
+{"version":3,"file":"routes.js","sourceRoot":"","sources":["../src/routes.ts"],"names":[],"mappings":"AAKA,mFAAmF;AACnF,MAAM,CAAC,MAAM,WAAW,GAAG;IACzB,sFAAsF;IACtF,EAAE,EAAE,YAAY;IAChB,+DAA+D;IAC/D,MAAM,EAAE,gBAAgB;IACxB,0EAA0E;IAC1E,QAAQ,EAAE,kBAAkB;IAC5B,4FAA4F;IAC5F,MAAM,EAAE,gBAAgB;IACxB,4FAA4F;IAC5F,MAAM,EAAE,gBAAgB;CAChB,CAAC;AAEX,8EAA8E;AAC9E,MAAM,CAAC,MAAM,mBAAmB,GAAG;IACjC,OAAO;IACP,WAAW;IACX,MAAM;IACN,OAAO;IACP,QAAQ;IACR,QAAQ;IACR,SAAS;IACT,MAAM;CACE,CAAC;AAIX,4FAA4F;AAC5F,MAAM,CAAC,MAAM,WAAW,GAAG;IACzB,mFAAmF;IACnF,KAAK,EAAE,CAAC,QAAqB,EAAU,EAAE,CAAC,SAAS,QAAQ,QAAQ;IACnE,oDAAoD;IACpD,QAAQ,EAAE,CAAC,QAAqB,EAAU,EAAE,CAAC,SAAS,QAAQ,WAAW;IACzE,mDAAmD;IACnD,MAAM,EAAE,cAAc;CACd,CAAC;AAEX,+FAA+F;AAC/F,MAAM,CAAC,MAAM,eAAe,GAAG,WAAW,CAAC;AAE3C;;;;GAIG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,SAAS,CAAC;AACvC,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,CAAU,CAAC;AAGpF,MAAM,UAAU,eAAe,CAAC,KAAgC;IAC9D,OAAQ,gBAAsC,CAAC,QAAQ,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC;AACvE,CAAC;AAED,sFAAsF;AACtF,MAAM,UAAU,SAAS,CAAC,QAAqB,EAAE,QAAgB;IAC/D,OAAO,GAAG,WAAW,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,eAAe,IAAI,kBAAkB,CAAC,QAAQ,CAAC,EAAE,CAAC;AAC7F,CAAC;AAED,uFAAuF;AACvF,MAAM,UAAU,UAAU,CAAC,IAAY,EAAE,OAAsB;IAC7D,OAAO,GAAG,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,aAAa,IAAI,OAAO,EAAE,CAAC;AAC/E,CAAC;AAED,6FAA6F;AAC7F,MAAM,UAAU,QAAQ,CAAC,UAA4C,EAAE,EAAU;IAC/E,OAAO,GAAG,WAAW,CAAC,UAAU,CAAC,IAAI,kBAAkB,CAAC,EAAE,CAAC,EAAE,CAAC;AAChE,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,WAAW,CAAC,GAAW,EAAE,UAA8B,EAAE,EAAW;IAClF,MAAM,IAAI,GAAG,QAAQ,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC;IACvC,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;IACD,OAAO,EAAE,KAAK,SAAS;QACrB,CAAC,CAAC,GAAG,IAAI,IAAI,UAAU,EAAE;QACzB,CAAC,CAAC,GAAG,IAAI,IAAI,UAAU,IAAI,kBAAkB,CAAC,EAAE,CAAC,EAAE,CAAC;AACxD,CAAC"}