@airtable/blocks 0.0.0-experimental-20e3506bd-20250428

package/dist/types/src/base/models/session.d.ts

@@ -0,0 +1,124 @@
+import { BaseSdkMode } from '../../sdk_mode';
+import { SessionCore } from '../../shared/models/session_core';
+import { PermissionCheckResult } from '../../shared/types/mutations_core';
+/**
+ * Model class representing the current user's session.
+ *
+ * @example
+ * ```js
+ * import {useSession} from '@airtable/blocks/ui';
+ *
+ * function Username() {
+ *     const session = useSession();
+ *
+ *     if (session.currentUser !== null) {
+ *         return <span>The current user's name is {session.currentUser.name}</span>;
+ *     } else {
+ *         return <span>This extension is being viewed in a public share</span>;
+ *     }
+ * }
+ * ```
+ * @docsPath models/Session
+ */
+declare class Session extends SessionCore<BaseSdkMode> {
+    /**
+     * Checks whether the current user has permission to update any records in the current base. For
+     * more granular permission checks, see {@link Table.checkPermissionsForUpdateRecords}.
+     *
+     * Returns `{hasPermission: true}` if the current user can update records,
+     * `{hasPermission: false, reasonDisplayString: string}` otherwise. `reasonDisplayString` may
+     * be used to display an error message to the user.
+     *
+     * @example
+     * ```js
+     * import {useSession} from '@airtable/blocks/ui';
+     *
+     * function UpdateButton({onClick}) {
+     *     const session = useSession();
+     *     const updateRecordsCheckResult = session.checkPermissionsForUpdateRecords();
+     *     const deniedReason = updateRecordsCheckResult.hasPermission
+     *         ? <span>{updateRecordsCheckResult.reasonDisplayString}</span>
+     *         : null;
+     *
+     *     return <div>
+     *         {deniedReason}
+     *         <button onClick={onClick} disabled={!!deniedReason}>
+     *             Update
+     *         </button>
+     *     </div>;
+     * }
+     */
+    checkPermissionsForUpdateRecords(): PermissionCheckResult;
+    /**
+     * An alias for `session.checkPermissionsForUpdateRecords().hasPermission`. For more granular
+     * permission checks, see {@link Table.hasPermissionToUpdateRecords}.
+     */
+    hasPermissionToUpdateRecords(): boolean;
+    /**
+     * Checks whether the current user has permission to create any records in the current base. For
+     * more granular permission checks, see {@link Table.checkPermissionsForCreateRecords}.
+     *
+     * Returns `{hasPermission: true}` if the current user can create records,
+     * `{hasPermission: false, reasonDisplayString: string}` otherwise. `reasonDisplayString` may be
+     * used to display an error message to the user.
+     *
+     * @example
+     * ```js
+     * import {useSession} from '@airtable/blocks/ui';
+     *
+     * function CreateButton({onClick}) {
+     *     const session = useSession();
+     *     const updateRecordsCheckResult = session.checkPermissionsForCreateRecords();
+     *     const deniedReason = updateRecordsCheckResult.hasPermission
+     *         ? <span>{updateRecordsCheckResult.reasonDisplayString}</span>
+     *         : null;
+     *
+     *     return <div>
+     *         {deniedReason}
+     *         <button onClick={onClick} disabled={!!deniedReason}>
+     *             Create
+     *         </button>
+     *     </div>;
+     * }
+     */
+    checkPermissionsForCreateRecords(): PermissionCheckResult;
+    /**
+     * An alias for `session.checkPermissionsForCreateRecords().hasPermission`. For more granular
+     * permission checks, see {@link Table.hasPermissionToCreateRecords}.
+     */
+    hasPermissionToCreateRecords(): boolean;
+    /**
+     * Checks whether the current user has permission to delete any records in the current base. For
+     * more granular permission checks, see {@link Table.checkPermissionsForDeleteRecords}.
+     *
+     * Returns `{hasPermission: true}` if the current user can delete records,
+     * `{hasPermission: false, reasonDisplayString: string}` otherwise. `reasonDisplayString` may be
+     * used to display an error message to the user.
+     *
+     * @example
+     * ```js
+     * import {useSession} from '@airtable/blocks/ui';
+     *
+     * function DeleteButton({onClick}) {
+     *     const session = useSession();
+     *     const updateRecordsCheckResult = session.checkPermissionsForDeleteRecords();
+     *     const deniedReason = updateRecordsCheckResult.hasPermission
+     *         ? <span>{updateRecordsCheckResult.reasonDisplayString}</span>
+     *         : null;
+     *
+     *     return <div>
+     *         {deniedReason}
+     *         <button onClick={onClick} disabled={!!deniedReason}>
+     *             Delete
+     *         </button>
+     *     </div>;
+     */
+    checkPermissionsForDeleteRecords(): PermissionCheckResult;
+    /**
+     * An alias for `session.checkPermissionsForDeleteRecords().hasPermission`. For more granular
+     * permission checks, see {@link Table.hasPermissionToDeleteRecords}.
+     */
+    hasPermissionToDeleteRecords(): boolean;
+}
+export default Session;
+//# sourceMappingURL=session.d.ts.map

package/dist/types/src/base/models/session.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"session.d.ts","sourceRoot":"","sources":["../../../../../src/base/models/session.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,WAAW,EAAC,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAC,WAAW,EAAC,MAAM,kCAAkC,CAAC;AAC7D,OAAO,EAAC,qBAAqB,EAAC,MAAM,mCAAmC,CAAC;AAGxE;;;;;;;;;;;;;;;;;;GAkBG;AACH,cAAM,OAAQ,SAAQ,WAAW,CAAC,WAAW,CAAC;IAG1C;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,gCAAgC,IAAI,qBAAqB;IAOzD;;;OAGG;IACH,4BAA4B,IAAI,OAAO;IAGvC;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,gCAAgC,IAAI,qBAAqB;IAOzD;;;OAGG;IACH,4BAA4B,IAAI,OAAO;IAGvC;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,gCAAgC,IAAI,qBAAqB;IAOzD;;;OAGG;IACH,4BAA4B,IAAI,OAAO;CAG1C;AAED,eAAe,OAAO,CAAC"}