@leaflow/sdk 0.0.0-dev.355.g42152f5 → 0.0.0-dev.357.gf8331d0

package/dist/iam/v1/generated/functions.js

@@ -34,6 +34,7 @@ export const getUpdateProjectUrl = () => {
     return `https://iam.leaflow.cloud/api/v1/project`;
 };
 /**
+ * The slug is not affected; it is set through `PUT /api/v1/project/slug`.
  * @summary Update the name and description of a project
  */
 export const updateProject = async (updateProjectRequestBody, options, fetchFn) => {
@@ -78,6 +79,47 @@ export const deleteProject = async (options, fetchFn) => {
     const data = body ? JSON.parse(body) : {};
     return { data, status: res.status, headers: res.headers };
 };
+export const getSetProjectSlugUrl = () => {
+    return `https://iam.leaflow.cloud/api/v1/project/slug`;
+};
+/**
+ * Replaces the default slug, which is the project's `id`, with a custom one. Only the owner can do this, and only once: a custom slug cannot be changed or removed afterwards. The address under the `id` keeps working.
+ *
+ * Setting the slug the project already holds succeeds without change. Fails with:
+ *
+ * - 400 `PROJECT_SLUG_INVALID` when the slug does not follow the format described on `slug`;
+ * - 422 `PROJECT_SLUG_RESERVED` when the name is reserved;
+ * - 409 `PROJECT_SLUG_TAKEN` when another project, including a deleted one, holds it;
+ * - 412 `PROJECT_SLUG_ALREADY_SET` when the project already holds a different custom slug;
+ * - 403 `PROJECT_PERMISSION_DENIED` when the caller is not the owner.
+ * @summary Set the custom slug of a project
+ */
+export const setProjectSlug = async (setProjectSlugRequestBody, options, fetchFn) => {
+    const getHeaders = (h) => {
+        if (!h)
+            return {};
+        if (h instanceof Headers)
+            return Object.fromEntries(h.entries());
+        if (Symbol.iterator in h) {
+            return Object.fromEntries(Array.from(h, (entry) => Array.from(entry)));
+        }
+        const headers = {};
+        for (const [name, value] of Object.entries(h)) {
+            if (value !== undefined)
+                headers[name] = value;
+        }
+        return headers;
+    };
+    const res = await (fetchFn ?? fetch)(getSetProjectSlugUrl(), {
+        ...options,
+        method: "PUT",
+        headers: { "Content-Type": "application/json", ...getHeaders(options?.headers) },
+        body: JSON.stringify(setProjectSlugRequestBody),
+    });
+    const body = [204, 205, 304].includes(res.status) ? null : await res.text();
+    const data = body ? JSON.parse(body) : {};
+    return { data, status: res.status, headers: res.headers };
+};
 export const getGetProjectMembershipUrl = () => {
     return `https://iam.leaflow.cloud/api/v1/membership`;
 };

package/dist/iam/v1/generated/models.d.ts

@@ -117,6 +117,12 @@ export interface ProjectResource {
     deleted_at: string | null;
     description: string;
     id: string;
+    /**
+     * The label naming the project in its address. It equals `id` until a custom slug is chosen. A custom slug does not change once set, and stays with the project after deletion
+     * @minLength 1
+     * @maxLength 36
+     */
+    slug: string;
     name: string;
     updated_at: string;
 }
@@ -130,6 +136,14 @@ export interface UpdateProjectRequestBody {
     /** @maxLength 128 */
     name?: string;
 }
+export interface SetProjectSlugRequestBody {
+    /**
+     * 6 to 32 characters made of lower-case letters, digits and single hyphens, beginning with a letter and ending with a letter or digit
+     * @minLength 6
+     * @maxLength 32
+     */
+    slug: string;
+}
 export interface QuotaResource {
     /** The service enforcing the quota. */
     service: string;

package/dist/iam/v1/generated/schemas.zod.d.ts

@@ -14,12 +14,28 @@
  */
 import * as zod from "zod";
 /**
+ * The slug is not affected; it is set through `PUT /api/v1/project/slug`.
  * @summary Update the name and description of a project
  */
 export declare const UpdateProjectBody: zod.ZodObject<{
     description: zod.ZodOptional<zod.ZodString>;
     name: zod.ZodOptional<zod.ZodString>;
 }, zod.z.core.$strict>;
+/**
+ * Replaces the default slug, which is the project's `id`, with a custom one. Only the owner can do this, and only once: a custom slug cannot be changed or removed afterwards. The address under the `id` keeps working.
+ *
+ * Setting the slug the project already holds succeeds without change. Fails with:
+ *
+ * - 400 `PROJECT_SLUG_INVALID` when the slug does not follow the format described on `slug`;
+ * - 422 `PROJECT_SLUG_RESERVED` when the name is reserved;
+ * - 409 `PROJECT_SLUG_TAKEN` when another project, including a deleted one, holds it;
+ * - 412 `PROJECT_SLUG_ALREADY_SET` when the project already holds a different custom slug;
+ * - 403 `PROJECT_PERMISSION_DENIED` when the caller is not the owner.
+ * @summary Set the custom slug of a project
+ */
+export declare const SetProjectSlugBody: zod.ZodObject<{
+    slug: zod.ZodString;
+}, zod.z.core.$strict>;
 /**
  * Visible to any member, on the same rule as the member list. Who has been invited is part of who is in the project.
  * @summary List the invitations this project is still waiting on

package/dist/iam/v1/generated/schemas.zod.js

@@ -21,14 +21,29 @@ import { IssueInvitationRequestBody } from "./validators/issueInvitationRequestB
 import { RenameSSHKeyRequestBody } from "./validators/renameSSHKeyRequestBody.zod.js";
 import { SetMemberPermissionsRequestBody } from "./validators/setMemberPermissionsRequestBody.zod.js";
 import { SetMemberRolesRequestBody } from "./validators/setMemberRolesRequestBody.zod.js";
+import { SetProjectSlugRequestBody } from "./validators/setProjectSlugRequestBody.zod.js";
 import { TransferOwnershipRequestBody } from "./validators/transferOwnershipRequestBody.zod.js";
 import { UpdatePolicyRequestBody } from "./validators/updatePolicyRequestBody.zod.js";
 import { UpdateProjectRequestBody } from "./validators/updateProjectRequestBody.zod.js";
 import { UpdateRoleRequestBody } from "./validators/updateRoleRequestBody.zod.js";
 /**
+ * The slug is not affected; it is set through `PUT /api/v1/project/slug`.
  * @summary Update the name and description of a project
  */
 export const UpdateProjectBody = UpdateProjectRequestBody;
+/**
+ * Replaces the default slug, which is the project's `id`, with a custom one. Only the owner can do this, and only once: a custom slug cannot be changed or removed afterwards. The address under the `id` keeps working.
+ *
+ * Setting the slug the project already holds succeeds without change. Fails with:
+ *
+ * - 400 `PROJECT_SLUG_INVALID` when the slug does not follow the format described on `slug`;
+ * - 422 `PROJECT_SLUG_RESERVED` when the name is reserved;
+ * - 409 `PROJECT_SLUG_TAKEN` when another project, including a deleted one, holds it;
+ * - 412 `PROJECT_SLUG_ALREADY_SET` when the project already holds a different custom slug;
+ * - 403 `PROJECT_PERMISSION_DENIED` when the caller is not the owner.
+ * @summary Set the custom slug of a project
+ */
+export const SetProjectSlugBody = SetProjectSlugRequestBody;
 /**
  * Visible to any member, on the same rule as the member list. Who has been invited is part of who is in the project.
  * @summary List the invitations this project is still waiting on

package/dist/iam/v1/generated/validators/projectAccessResource.zod.d.ts

@@ -46,6 +46,7 @@ export declare const ProjectAccessResource: zod.ZodObject<{
         deleted_at: zod.ZodNullable<zod.z.ZodISODateTime>;
         description: zod.ZodString;
         id: zod.ZodUUID;
+        slug: zod.ZodString;
         name: zod.ZodString;
         updated_at: zod.z.ZodISODateTime;
     }, zod.z.core.$strict>;

package/dist/iam/v1/generated/validators/projectResource.zod.d.ts

@@ -13,6 +13,7 @@
  * OpenAPI spec version: 1.0.0
  */
 import * as zod from "zod";
+export declare const projectResourceSlugMax = 36;
 export declare const ProjectResource: zod.ZodObject<{
     traits: zod.ZodArray<zod.ZodObject<{
         key: zod.ZodString;
@@ -29,6 +30,7 @@ export declare const ProjectResource: zod.ZodObject<{
     deleted_at: zod.ZodNullable<zod.z.ZodISODateTime>;
     description: zod.ZodString;
     id: zod.ZodUUID;
+    slug: zod.ZodString;
     name: zod.ZodString;
     updated_at: zod.z.ZodISODateTime;
 }, zod.z.core.$strict>;

package/dist/iam/v1/generated/validators/projectResource.zod.js

@@ -14,6 +14,7 @@
  */
 import * as zod from "zod";
 import { ProjectTraitResource } from "./projectTraitResource.zod.js";
+export const projectResourceSlugMax = 36;
 export const ProjectResource = zod.strictObject({
     traits: zod.array(ProjectTraitResource),
     deletion_requested_at: zod.iso.datetime({ offset: true }).nullable(),
@@ -25,6 +26,11 @@ export const ProjectResource = zod.strictObject({
         .describe("When the project was deleted"),
     description: zod.string(),
     id: zod.uuid(),
+    slug: zod
+        .string()
+        .min(1)
+        .max(projectResourceSlugMax)
+        .describe("The label naming the project in its address. It equals `id` until a custom slug is chosen. A custom slug does not change once set, and stays with the project after deletion"),
     name: zod.string(),
     updated_at: zod.iso.datetime({ offset: true }),
 });

package/dist/iam/v1/generated/validators/setProjectSlugRequestBody.zod.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow IAM API
+ * What happens inside a project: members, roles, invitations and SSH keys.
+ *
+ * Every request carries a scoped token; see the `bearerAuth` security scheme. No path carries a
+ * `projectId`, and the current project is the one the token states. Tokens are obtained from the
+ * account API.
+ *
+ * `GET /api/v1/membership` returns the roles and permissions the caller holds in the current
+ * project. It does not state whether a given operation is allowed; each service declares which permission its own operations require.
+ * OpenAPI spec version: 1.0.0
+ */
+import * as zod from "zod";
+export declare const setProjectSlugRequestBodySlugMin = 6;
+export declare const setProjectSlugRequestBodySlugMax = 32;
+export declare const SetProjectSlugRequestBody: zod.ZodObject<{
+    slug: zod.ZodString;
+}, zod.z.core.$strict>;
+export type SetProjectSlugRequestBody = zod.input<typeof SetProjectSlugRequestBody>;
+export type SetProjectSlugRequestBodyOutput = zod.output<typeof SetProjectSlugRequestBody>;

package/dist/iam/v1/generated/validators/setProjectSlugRequestBody.zod.js

@@ -0,0 +1,24 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow IAM API
+ * What happens inside a project: members, roles, invitations and SSH keys.
+ *
+ * Every request carries a scoped token; see the `bearerAuth` security scheme. No path carries a
+ * `projectId`, and the current project is the one the token states. Tokens are obtained from the
+ * account API.
+ *
+ * `GET /api/v1/membership` returns the roles and permissions the caller holds in the current
+ * project. It does not state whether a given operation is allowed; each service declares which permission its own operations require.
+ * OpenAPI spec version: 1.0.0
+ */
+import * as zod from "zod";
+export const setProjectSlugRequestBodySlugMin = 6;
+export const setProjectSlugRequestBodySlugMax = 32;
+export const SetProjectSlugRequestBody = zod.strictObject({
+    slug: zod
+        .string()
+        .min(setProjectSlugRequestBodySlugMin)
+        .max(setProjectSlugRequestBodySlugMax)
+        .describe("6 to 32 characters made of lower-case letters, digits and single hyphens, beginning with a letter and ending with a letter or digit"),
+});

package/dist/routes.d.ts

@@ -126,6 +126,30 @@ export declare const routes: readonly [{
     readonly operationId: "create-project";
     readonly securityScheme: "AccessToken";
     readonly upstreamUrl: "https://account.leaflow.cloud";
+}, {
+    readonly service: "account";
+    readonly contract: "account";
+    readonly method: "GET";
+    readonly path: "/account/v1/projects/by-slug/{slug}";
+    readonly operationId: "get-project-by-slug";
+    readonly securityScheme: "AccessToken";
+    readonly upstreamUrl: "https://account.leaflow.cloud";
+}, {
+    readonly service: "account";
+    readonly contract: "account";
+    readonly method: "GET";
+    readonly path: "/account/v1/projects/{projectId}";
+    readonly operationId: "get-project";
+    readonly securityScheme: "AccessToken";
+    readonly upstreamUrl: "https://account.leaflow.cloud";
+}, {
+    readonly service: "account";
+    readonly contract: "account";
+    readonly method: "GET";
+    readonly path: "/account/v1/project-slugs/{slug}/availability";
+    readonly operationId: "get-project-slug-availability";
+    readonly securityScheme: "AccessToken";
+    readonly upstreamUrl: "https://account.leaflow.cloud";
 }, {
     readonly service: "account";
     readonly contract: "account";
@@ -2318,6 +2342,14 @@ export declare const routes: readonly [{
     readonly operationId: "delete-project";
     readonly securityScheme: "ScopedToken";
     readonly upstreamUrl: "https://iam.leaflow.cloud";
+}, {
+    readonly service: "iam";
+    readonly contract: "iam";
+    readonly method: "PUT";
+    readonly path: "/api/v1/project/slug";
+    readonly operationId: "set-project-slug";
+    readonly securityScheme: "ScopedToken";
+    readonly upstreamUrl: "https://iam.leaflow.cloud";
 }, {
     readonly service: "iam";
     readonly contract: "iam";

package/dist/routes.js

@@ -144,6 +144,33 @@ export const routes = [
         securityScheme: "AccessToken",
         upstreamUrl: "https://account.leaflow.cloud",
     },
+    {
+        service: "account",
+        contract: "account",
+        method: "GET",
+        path: "/account/v1/projects/by-slug/{slug}",
+        operationId: "get-project-by-slug",
+        securityScheme: "AccessToken",
+        upstreamUrl: "https://account.leaflow.cloud",
+    },
+    {
+        service: "account",
+        contract: "account",
+        method: "GET",
+        path: "/account/v1/projects/{projectId}",
+        operationId: "get-project",
+        securityScheme: "AccessToken",
+        upstreamUrl: "https://account.leaflow.cloud",
+    },
+    {
+        service: "account",
+        contract: "account",
+        method: "GET",
+        path: "/account/v1/project-slugs/{slug}/availability",
+        operationId: "get-project-slug-availability",
+        securityScheme: "AccessToken",
+        upstreamUrl: "https://account.leaflow.cloud",
+    },
     {
         service: "account",
         contract: "account",
@@ -2610,6 +2637,15 @@ export const routes = [
         securityScheme: "ScopedToken",
         upstreamUrl: "https://iam.leaflow.cloud",
     },
+    {
+        service: "iam",
+        contract: "iam",
+        method: "PUT",
+        path: "/api/v1/project/slug",
+        operationId: "set-project-slug",
+        securityScheme: "ScopedToken",
+        upstreamUrl: "https://iam.leaflow.cloud",
+    },
     {
         service: "iam",
         contract: "iam",

package/dist/type/resource/v1/generated/validators/attachment.zod.d.ts

@@ -20,8 +20,8 @@ export declare const Attachment: zod.ZodObject<{
         id: zod.ZodUUID;
     }, zod.z.core.$strict>;
     state: zod.ZodEnum<{
-        unknown: "unknown";
         reserved: "reserved";
+        unknown: "unknown";
         attached: "attached";
         attaching: "attaching";
         detaching: "detaching";

package/dist/type/resource/v1/generated/validators/attachmentList.zod.d.ts

@@ -21,8 +21,8 @@ export declare const AttachmentList: zod.ZodObject<{
             id: zod.ZodUUID;
         }, zod.z.core.$strict>;
         state: zod.ZodEnum<{
-            unknown: "unknown";
             reserved: "reserved";
+            unknown: "unknown";
             attached: "attached";
             attaching: "attaching";
             detaching: "detaching";

package/dist/type/resource/v1/generated/validators/resourceUsage.zod.d.ts

@@ -23,9 +23,9 @@ export declare const ResourceUsage: zod.ZodObject<{
     }, zod.z.core.$strict>;
     purpose: zod.ZodString;
     state: zod.ZodEnum<{
+        reserved: "reserved";
         active: "active";
         releasing: "releasing";
-        reserved: "reserved";
         released: "released";
     }>;
     generation: zod.ZodInt;

package/dist/type/resource/v1/generated/validators/resourceUsageList.zod.d.ts

@@ -22,9 +22,9 @@ export declare const ResourceUsageList: zod.ZodObject<{
         }, zod.z.core.$strict>;
         purpose: zod.ZodString;
         state: zod.ZodEnum<{
+            reserved: "reserved";
             active: "active";
             releasing: "releasing";
-            reserved: "reserved";
             released: "released";
         }>;
         generation: zod.ZodInt;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@leaflow/sdk",
-  "version": "0.0.0-dev.355.g42152f5",
+  "version": "0.0.0-dev.357.gf8331d0",
   "description": "Leaflow 平台 API 的 TypeScript SDK",
   "license": "MIT",
   "repository": {