studiokit-scaffolding-js 4.3.20 → 4.3.21

package/lib/types/User.d.ts

@@ -1,68 +1,68 @@
-import { Model } from 'studiokit-net-js';
-/**
- * Simple User object for with general data for displaying users
- */
-export interface User extends Model {
-    /**
-     * App Id of User
-     */
-    id: string;
-    /**
-     * User's given name
-     */
-    firstName: string | null;
-    /**
-     * User's family name
-     */
-    lastName: string | null;
-    /**
-     * User's email
-     */
-    email: string | null;
-    /**
-     * External email with domain removed. Equivalent to careerAccountAlias for Purdue
-     */
-    uid: string | null;
-}
-/**
- * More detailed user object from UserInfo api
- */
-export interface UserInfo extends User {
-    /**
-     * Equivalent to email
-     */
-    userName: string;
-    /**
-     * Purdue user's career account alias
-     */
-    careerAccountAlias: string | null;
-    /**
-     * External User Id. Equivalent to puid for Purdue
-     */
-    employeeNumber: string | null;
-    /**
-     * User's Purdue Id
-     */
-    puid: string | null;
-    /**
-     * Array of global roles for the User
-     */
-    roles: string[];
-    /**
-     * Array of global activities for the User
-     */
-    activities: string[];
-    /**
-     * Date string when user's demo started. Null when not on demo shard
-     */
-    dateDemoGenerationSucceeded: string | null;
-    dateStored: string;
-    dateLastUpdated: string;
-    /**
-     * Whether or not the User is being impersonated by another User
-     */
-    isImpersonated: boolean;
-}
-export interface EntityUser extends User {
-    entityId: number;
-}
+import { Model } from 'studiokit-net-js';
+/**
+ * Simple User object for with general data for displaying users
+ */
+export interface User extends Model {
+    /**
+     * App Id of User
+     */
+    id: string;
+    /**
+     * User's given name
+     */
+    firstName: string | null;
+    /**
+     * User's family name
+     */
+    lastName: string | null;
+    /**
+     * User's email
+     */
+    email: string | null;
+    /**
+     * External email with domain removed. Equivalent to careerAccountAlias for Purdue
+     */
+    uid: string | null;
+}
+/**
+ * More detailed user object from UserInfo api
+ */
+export interface UserInfo extends User {
+    /**
+     * Equivalent to email
+     */
+    userName: string;
+    /**
+     * Purdue user's career account alias
+     */
+    careerAccountAlias: string | null;
+    /**
+     * External User Id. Equivalent to puid for Purdue
+     */
+    employeeNumber: string | null;
+    /**
+     * User's Purdue Id
+     */
+    puid: string | null;
+    /**
+     * Array of global roles for the User
+     */
+    roles: string[];
+    /**
+     * Array of global activities for the User
+     */
+    activities: string[];
+    /**
+     * Date string when user's demo started. Null when not on demo shard
+     */
+    dateDemoGenerationSucceeded: string | null;
+    dateStored: string;
+    dateLastUpdated: string;
+    /**
+     * Whether or not the User is being impersonated by another User
+     */
+    isImpersonated: boolean;
+}
+export interface EntityUser extends User {
+    entityId: number;
+}

package/lib/types/User.js

@@ -1,2 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/types/UserRole.d.ts

@@ -1,19 +1,19 @@
-import { User } from './User';
-export interface UserRole {
-    userId: string;
-    role: string;
-}
-export interface EntityUserRole extends UserRole {
-    entityId: number;
-}
-export interface GroupUserRole extends EntityUserRole {
-    isExternal: boolean;
-}
-export interface UserWithRoles<TUserRole extends UserRole = UserRole> extends User {
-    roles: TUserRole[];
-}
-export interface EntityUserWithRoles<TUserRole extends EntityUserRole = EntityUserRole> extends UserWithRoles<TUserRole> {
-    entityId: number;
-}
-export interface GroupUserWithRoles extends EntityUserWithRoles<GroupUserRole> {
-}
+import { User } from './User';
+export interface UserRole {
+    userId: string;
+    role: string;
+}
+export interface EntityUserRole extends UserRole {
+    entityId: number;
+}
+export interface GroupUserRole extends EntityUserRole {
+    isExternal: boolean;
+}
+export interface UserWithRoles<TUserRole extends UserRole = UserRole> extends User {
+    roles: TUserRole[];
+}
+export interface EntityUserWithRoles<TUserRole extends EntityUserRole = EntityUserRole> extends UserWithRoles<TUserRole> {
+    entityId: number;
+}
+export interface GroupUserWithRoles extends EntityUserWithRoles<GroupUserRole> {
+}

package/lib/types/UserRole.js

@@ -1,2 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/types/index.d.ts

@@ -1,21 +1,21 @@
-export * from './AppConfiguration';
-export * from './Artifact';
-export * from './BaseReduxState';
-export * from './Client';
-export * from './Collection';
-export * from './Configuration';
-export * from './DeletableModel';
-export * from './External';
-export * from './Group';
-export * from './IdentityProvider';
-export * from './LtiLaunch';
-export * from './Notification';
-export * from './OptionalRecord';
-export * from './OwnerSchedule';
-export * from './PropertyOfType';
-export * from './RoleDescription';
-export * from './Search';
-export * from './SimpleLocation';
-export * from './UniTime';
-export * from './User';
-export * from './UserRole';
+export * from './AppConfiguration';
+export * from './Artifact';
+export * from './BaseReduxState';
+export * from './Client';
+export * from './Collection';
+export * from './Configuration';
+export * from './DeletableModel';
+export * from './External';
+export * from './Group';
+export * from './IdentityProvider';
+export * from './LtiLaunch';
+export * from './Notification';
+export * from './OptionalRecord';
+export * from './OwnerSchedule';
+export * from './PropertyOfType';
+export * from './RoleDescription';
+export * from './Search';
+export * from './SimpleLocation';
+export * from './UniTime';
+export * from './User';
+export * from './UserRole';

package/lib/types/index.js

@@ -1,33 +1,33 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./AppConfiguration"), exports);
-__exportStar(require("./Artifact"), exports);
-__exportStar(require("./BaseReduxState"), exports);
-__exportStar(require("./Client"), exports);
-__exportStar(require("./Collection"), exports);
-__exportStar(require("./Configuration"), exports);
-__exportStar(require("./DeletableModel"), exports);
-__exportStar(require("./External"), exports);
-__exportStar(require("./Group"), exports);
-__exportStar(require("./IdentityProvider"), exports);
-__exportStar(require("./LtiLaunch"), exports);
-__exportStar(require("./Notification"), exports);
-__exportStar(require("./OptionalRecord"), exports);
-__exportStar(require("./OwnerSchedule"), exports);
-__exportStar(require("./PropertyOfType"), exports);
-__exportStar(require("./RoleDescription"), exports);
-__exportStar(require("./Search"), exports);
-__exportStar(require("./SimpleLocation"), exports);
-__exportStar(require("./UniTime"), exports);
-__exportStar(require("./User"), exports);
-__exportStar(require("./UserRole"), exports);
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./AppConfiguration"), exports);
+__exportStar(require("./Artifact"), exports);
+__exportStar(require("./BaseReduxState"), exports);
+__exportStar(require("./Client"), exports);
+__exportStar(require("./Collection"), exports);
+__exportStar(require("./Configuration"), exports);
+__exportStar(require("./DeletableModel"), exports);
+__exportStar(require("./External"), exports);
+__exportStar(require("./Group"), exports);
+__exportStar(require("./IdentityProvider"), exports);
+__exportStar(require("./LtiLaunch"), exports);
+__exportStar(require("./Notification"), exports);
+__exportStar(require("./OptionalRecord"), exports);
+__exportStar(require("./OwnerSchedule"), exports);
+__exportStar(require("./PropertyOfType"), exports);
+__exportStar(require("./RoleDescription"), exports);
+__exportStar(require("./Search"), exports);
+__exportStar(require("./SimpleLocation"), exports);
+__exportStar(require("./UniTime"), exports);
+__exportStar(require("./User"), exports);
+__exportStar(require("./UserRole"), exports);

package/lib/utils/baseActivity.d.ts

@@ -1,63 +1,63 @@
-import { Model, ModelCollection } from 'studiokit-net-js';
-import { BaseReduxState, UserInfo } from '../types';
-export interface ActivityOptions {
-    entity?: Model & {
-        activities?: string[];
-    };
-    entities?: ModelCollection;
-    userInfo?: UserInfo;
-}
-/**
- * Return true if user has activity for the single entity
- *
- * @param {string} requiredActivity The activity required to return true
- * @param {object} options See above
- */
-export declare const canPerformActivityOnEntity: (requiredActivity: string, options: ActivityOptions) => boolean;
-/**
- * Return true if user has activity on any of the entities
- *
- * @param {string} requiredActivity The activity required to return true
- * @param {object} options See above
- */
-export declare const canPerformActivityOnSomeEntities: (requiredActivity: string, options: ActivityOptions) => boolean;
-/**
- * Return true if user has activity globally
- *
- * This function can accept an null/undefined userInfo property for the
- * options argument. In which case it returns false. This is because userInfo
- * may not be loaded yet. If it is provided however, it must contain an
- * activities array
- *
- * @param {string} requiredActivity The activity required to return true
- * @param {object} options See above
- */
-export declare const canPerformActivityGlobally: (requiredActivity: string, options: ActivityOptions) => boolean;
-/**
- * Return true if user has activity either globally or on a single entity
- *
- * @param {string} requiredActivity The activity required to return true
- * @param {object} options See above
- */
-export declare const canPerformActivityGloballyOrOnEntity: (requiredActivity: string, options: ActivityOptions) => boolean;
-/**
- * Return true if user has activity globally or on any of the entities provided
- *
- * @param {string} requiredActivity The activity required to return true
- * @param {object} options See above
- */
-export declare const canPerformActivityGloballyOrOnSomeEntities: (requiredActivity: string, options: ActivityOptions) => boolean;
-/**
- * Return an options object that can be used in the functions in this module. This
- * encapsulates the default logic of looking in state for a set of entities or
- * looking in props for a single entity.
- *
- * Override or decorate with app specific logic in your app if needed.
- *
- * @param {Object} state The redux state
- * @param {Object} [props] A props object (typically ownProps)
- * @param {string} [modelsProperty] The property used to locate the entity or entities
- * needed for entity-level activity grants. For sets of entities, this function
- * looks in `state.models`. For a single entity, it looks in `props`
- */
-export declare const defaultOptions: (state: BaseReduxState, props?: any, modelsProperty?: string | undefined) => ActivityOptions;
+import { Model, ModelCollection } from 'studiokit-net-js';
+import { BaseReduxState, UserInfo } from '../types';
+export interface ActivityOptions {
+    entity?: Model & {
+        activities?: string[];
+    };
+    entities?: ModelCollection;
+    userInfo?: UserInfo;
+}
+/**
+ * Return true if user has activity for the single entity
+ *
+ * @param {string} requiredActivity The activity required to return true
+ * @param {object} options See above
+ */
+export declare const canPerformActivityOnEntity: (requiredActivity: string, options: ActivityOptions) => boolean;
+/**
+ * Return true if user has activity on any of the entities
+ *
+ * @param {string} requiredActivity The activity required to return true
+ * @param {object} options See above
+ */
+export declare const canPerformActivityOnSomeEntities: (requiredActivity: string, options: ActivityOptions) => boolean;
+/**
+ * Return true if user has activity globally
+ *
+ * This function can accept an null/undefined userInfo property for the
+ * options argument. In which case it returns false. This is because userInfo
+ * may not be loaded yet. If it is provided however, it must contain an
+ * activities array
+ *
+ * @param {string} requiredActivity The activity required to return true
+ * @param {object} options See above
+ */
+export declare const canPerformActivityGlobally: (requiredActivity: string, options: ActivityOptions) => boolean;
+/**
+ * Return true if user has activity either globally or on a single entity
+ *
+ * @param {string} requiredActivity The activity required to return true
+ * @param {object} options See above
+ */
+export declare const canPerformActivityGloballyOrOnEntity: (requiredActivity: string, options: ActivityOptions) => boolean;
+/**
+ * Return true if user has activity globally or on any of the entities provided
+ *
+ * @param {string} requiredActivity The activity required to return true
+ * @param {object} options See above
+ */
+export declare const canPerformActivityGloballyOrOnSomeEntities: (requiredActivity: string, options: ActivityOptions) => boolean;
+/**
+ * Return an options object that can be used in the functions in this module. This
+ * encapsulates the default logic of looking in state for a set of entities or
+ * looking in props for a single entity.
+ *
+ * Override or decorate with app specific logic in your app if needed.
+ *
+ * @param {Object} state The redux state
+ * @param {Object} [props] A props object (typically ownProps)
+ * @param {string} [modelsProperty] The property used to locate the entity or entities
+ * needed for entity-level activity grants. For sets of entities, this function
+ * looks in `state.models`. For a single entity, it looks in `props`
+ */
+export declare const defaultOptions: (state: BaseReduxState, props?: any, modelsProperty?: string | undefined) => ActivityOptions;