@stackframe/stack-shared 2.5.6 → 2.5.8

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @stackframe/stack-shared
 
+## 2.5.8
+
+### Patch Changes
+
+- Improved docs
+  - @stackframe/stack-sc@2.5.8
+
+## 2.5.7
+
+### Patch Changes
+
+- @stackframe/stack-sc@2.5.7
+
 ## 2.5.6
 
 ### Patch Changes

package/dist/crud.d.ts

@@ -11,6 +11,7 @@ declare module 'yup' {
             description?: string;
             exampleValue?: any;
             hidden?: boolean;
+            onlyShowInOperations?: Capitalize<CrudlOperation>[];
         };
     }
 }
@@ -18,6 +19,7 @@ type ShownEndpointDocumentation = {
     summary: string;
     description: string;
     tags?: string[];
+    crudOperation?: Capitalize<CrudlOperation>;
 };
 export type EndpointDocumentation = ({
     hidden: true;

package/dist/interface/crud/current-user.d.ts

@@ -8,7 +8,6 @@ export declare const currentUserCrud: import("../../crud").CrudSchemaFromOptions
             id: string;
             account_id: string;
         }[];
-        project_id: string;
         primary_email: string | null;
         profile_image_url: string | null;
         client_metadata: {} | null;
@@ -24,7 +23,6 @@ export declare const currentUserCrud: import("../../crud").CrudSchemaFromOptions
             profile_image_url: string | null;
         } | null;
     }) | null, import("yup").AnyObject, {
-        project_id: undefined;
         id: undefined;
         primary_email: undefined;
         primary_email_verified: undefined;
@@ -44,7 +42,6 @@ export declare const currentUserCrud: import("../../crud").CrudSchemaFromOptions
         server_metadata: undefined;
     }, "">;
     serverReadSchema: import("yup").ObjectSchema<{
-        project_id: string;
         id: string;
         primary_email: string | null;
         primary_email_verified: NonNullable<boolean | undefined>;
@@ -68,7 +65,6 @@ export declare const currentUserCrud: import("../../crud").CrudSchemaFromOptions
         client_metadata: {} | null;
         server_metadata: {} | null;
     } | null, import("yup").AnyObject, {
-        project_id: undefined;
         id: undefined;
         primary_email: undefined;
         primary_email_verified: undefined;

package/dist/interface/crud/current-user.js

@@ -9,7 +9,6 @@ const clientUpdateSchema = usersCrudServerUpdateSchema.pick([
 ]).required();
 const serverUpdateSchema = usersCrudServerUpdateSchema;
 const clientReadSchema = usersCrudServerReadSchema.pick([
-    "project_id",
     "id",
     "primary_email",
     "primary_email_verified",

package/dist/interface/crud/team-permissions.js

@@ -15,13 +15,13 @@ export const teamPermissionsCrud = createCrud({
     serverDeleteSchema: teamPermissionsCrudServerDeleteSchema,
     docs: {
         clientList: {
-            summary: "List team permissions of the current user",
-            description: "user_id=me needs to be set",
+            summary: "List team permissions",
+            description: "List team permissions of the current user. `user_id=me` must be set for client requests. Note that this might contain the permissions with the same permission ID across different teams. `(team_id, user_id, permission_id)` together uniquely identify a permission.",
             tags: ["Permissions"],
         },
         serverList: {
             summary: "List team permissions of a user",
-            description: "Query and filter the permission with team_id, user_id, and permission_id",
+            description: "Query and filter the permission with `team_id`, `user_id`, and `permission_id`. Note that this might contain the permissions with the same permission ID across different teams and users. `(team_id, user_id, permission_id)` together uniquely identify a permission.",
             tags: ["Permissions"],
         },
         serverCreate: {

package/dist/interface/crud/teams.js

@@ -38,12 +38,12 @@ export const teamsCrud = createCrud({
     docs: {
         clientList: {
             summary: "List teams",
-            description: "List all the teams that the current user is a member of.",
+            description: "List all the teams that the current user is a member of. `user_id=me` must be passed in the query parameters.",
             tags: ["Teams"],
         },
         clientCreate: {
             summary: "Create a team",
-            description: "Create a new team and add the current user as a member.",
+            description: "Create a new team and optionally add the current user as a member.",
             tags: ["Teams"],
         },
         clientRead: {
@@ -53,7 +53,7 @@ export const teamsCrud = createCrud({
         },
         serverCreate: {
             summary: "Create a team",
-            description: "Create a new team and add the current user as a member.",
+            description: "Create a new team and optionally add the current user as a member.",
             tags: ["Teams"],
         },
         serverList: {
@@ -68,7 +68,7 @@ export const teamsCrud = createCrud({
         },
         serverUpdate: {
             summary: "Update a team",
-            description: "Update a team by ID.",
+            description: "Update the team information by ID.",
             tags: ["Teams"],
         },
         serverDelete: {

package/dist/interface/crud/users.d.ts

@@ -21,7 +21,6 @@ export declare const usersCrudServerUpdateSchema: import("yup").ObjectSchema<{
     selected_team_id: undefined;
 }, "">;
 export declare const usersCrudServerReadSchema: import("yup").ObjectSchema<{
-    project_id: string;
     id: string;
     primary_email: string | null;
     primary_email_verified: NonNullable<boolean | undefined>;
@@ -45,7 +44,6 @@ export declare const usersCrudServerReadSchema: import("yup").ObjectSchema<{
     client_metadata: {} | null;
     server_metadata: {} | null;
 }, import("yup").AnyObject, {
-    project_id: undefined;
     id: undefined;
     primary_email: undefined;
     primary_email_verified: undefined;
@@ -96,7 +94,6 @@ export declare const usersCrudServerCreateSchema: import("yup").ObjectSchema<{
 export declare const usersCrudServerDeleteSchema: import("yup").MixedSchema<{} | undefined, import("yup").AnyObject, undefined, "">;
 export declare const usersCrud: import("../../crud").CrudSchemaFromOptions<{
     serverReadSchema: import("yup").ObjectSchema<{
-        project_id: string;
         id: string;
         primary_email: string | null;
         primary_email_verified: NonNullable<boolean | undefined>;
@@ -120,7 +117,6 @@ export declare const usersCrud: import("../../crud").CrudSchemaFromOptions<{
         client_metadata: {} | null;
         server_metadata: {} | null;
     }, import("yup").AnyObject, {
-        project_id: undefined;
         id: undefined;
         primary_email: undefined;
         primary_email_verified: undefined;

package/dist/interface/crud/users.js

@@ -13,7 +13,6 @@ export const usersCrudServerUpdateSchema = fieldSchema.yupObject({
     selected_team_id: fieldSchema.selectedTeamIdSchema.nullable().optional(),
 }).required();
 export const usersCrudServerReadSchema = fieldSchema.yupObject({
-    project_id: fieldSchema.projectIdSchema.required(),
     id: fieldSchema.userIdSchema.required(),
     primary_email: fieldSchema.primaryEmailSchema.nullable().defined(),
     primary_email_verified: fieldSchema.primaryEmailVerifiedSchema.required(),
@@ -28,7 +27,7 @@ export const usersCrudServerReadSchema = fieldSchema.yupObject({
         id: fieldSchema.yupString().required(),
         account_id: fieldSchema.yupString().required(),
         email: fieldSchema.yupString().nullable(),
-    }).required()).required().meta({ openapiField: { description: 'A list of OAuth providers connected to this account', exampleValue: ['google', 'github'] } }),
+    }).required()).required().meta({ openapiField: { description: 'A list of OAuth providers connected to this account', exampleValue: [{ id: 'google', account_id: '12345', email: 'john.doe@gmail.com' }] } }),
     client_metadata: fieldSchema.userClientMetadataSchema,
     server_metadata: fieldSchema.userServerMetadataSchema,
 }).required();

package/dist/schema-fields.js

@@ -1,12 +1,13 @@
 import * as yup from "yup";
 import { isUuid } from "./utils/uuids";
-const _idDescription = (identify) => `The immutable ID used to uniquely identify this ${identify}`;
-const _displayNameDescription = (identify) => `Human-readable ${identify} display name, used in places like frontend UI. This is not a unique identifier.`;
+const _idDescription = (identify) => `The unique identifier of this ${identify}`;
+const _displayNameDescription = (identify) => `Human-readable ${identify} display name. This is not a unique identifier.`;
 const _clientMetaDataDescription = (identify) => `Client metadata. Used as a data store, accessible from the client side. Do not store information that should not be exposed to the client.`;
 const _serverMetaDataDescription = (identify) => `Server metadata. Used as a data store, only accessible from the server side. You can store secret information related to the ${identify} here.`;
 const _atMillisDescription = (identify) => `(the number of milliseconds since epoch, January 1, 1970, UTC)`;
 const _createdAtMillisDescription = (identify) => `The time the ${identify} was created ${_atMillisDescription(identify)}`;
 const _updatedAtMillisDescription = (identify) => `The time the ${identify} was last updated ${_atMillisDescription(identify)}`;
+const _signedUpAtMillisDescription = `The time the user signed up ${_atMillisDescription}`;
 // Built-in replacements
 /* eslint-disable no-restricted-syntax */
 export function yupString(...args) {
@@ -143,8 +144,8 @@ export const primaryEmailSchema = emailSchema.meta({ openapiField: { description
 export const primaryEmailVerifiedSchema = yupBoolean().meta({ openapiField: { description: 'Whether the primary email has been verified to belong to this user', exampleValue: true } });
 export const userDisplayNameSchema = yupString().nullable().meta({ openapiField: { description: _displayNameDescription('user'), exampleValue: 'John Doe' } });
 export const selectedTeamIdSchema = yupString().meta({ openapiField: { description: 'ID of the team currently selected by the user', exampleValue: 'team-id' } });
-export const profileImageUrlSchema = yupString().meta({ openapiField: { description: 'Profile image URL', exampleValue: 'https://example.com/image.jpg' } });
-export const signedUpAtMillisSchema = yupNumber().meta({ openapiField: { description: 'Signed up at milliseconds', exampleValue: 1630000000000 } });
+export const profileImageUrlSchema = yupString().meta({ openapiField: { description: 'Profile image URL. Can be a Base64 encoded image. Please compress and crop to a square before passing in.', exampleValue: 'https://example.com/image.jpg' } });
+export const signedUpAtMillisSchema = yupNumber().meta({ openapiField: { description: _signedUpAtMillisDescription, exampleValue: 1630000000000 } });
 export const userClientMetadataSchema = jsonSchema.meta({ openapiField: { description: _clientMetaDataDescription('user'), exampleValue: { key: 'value' } } });
 export const userServerMetadataSchema = jsonSchema.meta({ openapiField: { description: _serverMetaDataDescription('user'), exampleValue: { key: 'value' } } });
 // Auth
@@ -177,7 +178,7 @@ export const teamPermissionDefinitionIdSchema = yupString()
     }
     return true;
 })
-    .meta({ openapiField: { description: `The permission ID used to uniquely identify a permission. Can either be a custom permission with lowercase letters, numbers, ":", and "_" characters, or one of the system permissions: ${teamSystemPermissions.join(', ')}`, exampleValue: '$read_secret_info' } });
+    .meta({ openapiField: { description: `The permission ID used to uniquely identify a permission. Can either be a custom permission with lowercase letters, numbers, \`:\`, and \`_\` characters, or one of the system permissions: ${teamSystemPermissions.map(x => `\`${x}\``).join(', ')}`, exampleValue: 'read_secret_info' } });
 export const customTeamPermissionDefinitionIdSchema = yupString()
     .matches(/^[a-z0-9_:]+$/, 'Only lowercase letters, numbers, ":", "_" are allowed')
     .meta({ openapiField: { description: 'The permission ID used to uniquely identify a permission. Can only contain lowercase letters, numbers, ":", and "_" characters', exampleValue: 'read_secret_info' } });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stackframe/stack-shared",
-  "version": "2.5.6",
+  "version": "2.5.8",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": [
@@ -36,7 +36,7 @@
     "jose": "^5.2.2",
     "oauth4webapi": "^2.10.3",
     "uuid": "^9.0.1",
-    "@stackframe/stack-sc": "2.5.6"
+    "@stackframe/stack-sc": "2.5.8"
   },
   "devDependencies": {
     "rimraf": "^5.0.5",