@glissandoo/lib 1.108.1 → 1.108.2

package/functions/index.d.ts

@@ -175,5 +175,11 @@ export declare enum FbFunctionName {
     WebhookEventOnCreate = "webhookEvent-onCreate",
     WebhookGocardless = "webhook-gocardless",
     WebhookMessagebird = "webhook-messagebird",
-    WebhookStripe = "webhook-stripe"
+    WebhookStripe = "webhook-stripe",
+    InventoryAddType = "inventory-addType",
+    InventoryDeleteType = "inventory-deleteType",
+    InventoryMerge = "inventory-merge",
+    InventoryItemAdd = "inventoryItem-add",
+    InventoryItemDelete = "inventoryItem-delete",
+    InventoryItemEdit = "inventoryItem-edit"
 }

package/functions/index.js

@@ -181,4 +181,10 @@ var FbFunctionName;
     FbFunctionName["WebhookGocardless"] = "webhook-gocardless";
     FbFunctionName["WebhookMessagebird"] = "webhook-messagebird";
     FbFunctionName["WebhookStripe"] = "webhook-stripe";
+    FbFunctionName["InventoryAddType"] = "inventory-addType";
+    FbFunctionName["InventoryDeleteType"] = "inventory-deleteType";
+    FbFunctionName["InventoryMerge"] = "inventory-merge";
+    FbFunctionName["InventoryItemAdd"] = "inventoryItem-add";
+    FbFunctionName["InventoryItemDelete"] = "inventoryItem-delete";
+    FbFunctionName["InventoryItemEdit"] = "inventoryItem-edit";
 })(FbFunctionName = exports.FbFunctionName || (exports.FbFunctionName = {}));

package/functions/inventory.d.ts

@@ -0,0 +1,22 @@
+import { AInventoryTypeCustomField } from '../models/Inventory/types';
+export declare namespace InventoryFbFunctionsTypes {
+    interface AddTypeParams {
+        inventoryId: string;
+        typeId: string;
+        groupId: string;
+        name: string;
+        customFields: Omit<AInventoryTypeCustomField, 'createdAt' | 'updatedAt' | 'createdBy' | 'updatedBy'>[];
+    }
+    type AddTypeResult = void;
+    interface DeleteTypeParams {
+        inventoryId: string;
+        groupId: string;
+        typeId: string;
+    }
+    type DeleteTypeResult = void;
+    interface MergeParams {
+        baseGroupId: string;
+        targetGroupId: string;
+    }
+    type MergeResult = void;
+}

package/functions/inventory.js

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

package/functions/inventoryItem.d.ts

@@ -0,0 +1,29 @@
+import { InventoryItemCustomFieldValue, InventoryItemStatus } from '../models/Inventory/Item/types';
+export declare namespace InventoryItemFbFunctionsTypes {
+    interface AddParams {
+        itemId: string;
+        inventoryId: string;
+        groupId: string;
+        typeId: string;
+        title: string;
+        thumbnailURL: string | null;
+        fieldValues: Record<string, InventoryItemCustomFieldValue>;
+    }
+    type AddResult = void;
+    interface EditParams {
+        itemId: string;
+        inventoryId: string;
+        groupId: string;
+        title: string;
+        status: InventoryItemStatus;
+        thumbnailUrl: string | null;
+        fieldValues: Record<string, InventoryItemCustomFieldValue>;
+    }
+    type EditResult = void;
+    interface DeleteParams {
+        itemId: string;
+        inventoryId: string;
+        groupId: string;
+    }
+    type DeleteResult = void;
+}

package/functions/inventoryItem.js

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

package/functions/regions.js

@@ -188,6 +188,12 @@ const regionByFunctions = {
     [index_1.FbFunctionName.WebhookGocardless]: GCloudRegions.EuropeWest6,
     [index_1.FbFunctionName.WebhookMessagebird]: GCloudRegions.EuropeWest6,
     [index_1.FbFunctionName.WebhookStripe]: GCloudRegions.EuropeWest6,
+    [index_1.FbFunctionName.InventoryAddType]: GCloudRegions.EuropeWest6,
+    [index_1.FbFunctionName.InventoryDeleteType]: GCloudRegions.EuropeWest6,
+    [index_1.FbFunctionName.InventoryMerge]: GCloudRegions.EuropeWest6,
+    [index_1.FbFunctionName.InventoryItemAdd]: GCloudRegions.EuropeWest6,
+    [index_1.FbFunctionName.InventoryItemDelete]: GCloudRegions.EuropeWest6,
+    [index_1.FbFunctionName.InventoryItemEdit]: GCloudRegions.EuropeWest6,
 };
 const getFunctionRegion = (fn) => regionByFunctions[fn] || defaultRegion;
 exports.getFunctionRegion = getFunctionRegion;

package/helpers/collections.d.ts

@@ -32,5 +32,7 @@ export declare enum CollectionNames {
     FederationPartnerships = "partnerships",
     Offer = "offer",
     OfferApplicants = "applicants",
-    WebhookEvent = "webhookEvent"
+    WebhookEvent = "webhookEvent",
+    Inventory = "inventory",
+    InventoryItems = "inventoryItems"
 }

package/helpers/collections.js

@@ -37,4 +37,6 @@ var CollectionNames;
     CollectionNames["Offer"] = "offer";
     CollectionNames["OfferApplicants"] = "applicants";
     CollectionNames["WebhookEvent"] = "webhookEvent";
+    CollectionNames["Inventory"] = "inventory";
+    CollectionNames["InventoryItems"] = "inventoryItems";
 })(CollectionNames = exports.CollectionNames || (exports.CollectionNames = {}));

package/models/Group/index.d.ts

@@ -131,4 +131,6 @@ export default class Group extends GroupBasic<GroupData> {
     } | undefined;
     get customFields(): Record<string, import("./types").GroupCustomField>;
     get customFieldsList(): AGroupCustomField[];
+    get inventoryId(): string;
+    get coverURL(): string | null;
 }

package/models/Group/index.js

@@ -292,5 +292,11 @@ class Group extends basic_1.default {
         }))
             .sort((a, b) => a.order - b.order);
     }
+    get inventoryId() {
+        return this.data.inventoryId;
+    }
+    get coverURL() {
+        return this.data.coverURL || null;
+    }
 }
 exports.default = Group;

package/models/Group/types.d.ts

@@ -71,7 +71,8 @@ export declare enum AdminPermissions {
     Repertoire = "repertoire",
     Communications = "communications",
     Offers = "offers",
-    Billing = "billing"
+    Billing = "billing",
+    Inventory = "inventory"
 }
 export declare enum GroupConfigKey {
     IncludesMembersToEventsWhenJoined = "includesMembersToEventsWhenJoined",
@@ -249,6 +250,8 @@ export interface GroupData extends GroupBasicData {
     subscriptionId: string | null;
     questions: Record<string, GroupEventQuestion>;
     customFields: Record<string, GroupCustomField>;
+    inventoryId: string;
+    coverURL: string | null;
     readonly createdOn: CreatedOn;
     readonly owner: DocumentReference;
     readonly createdAt: Timestamp;

package/models/Group/types.js

@@ -45,6 +45,7 @@ var AdminPermissions;
     AdminPermissions["Communications"] = "communications";
     AdminPermissions["Offers"] = "offers";
     AdminPermissions["Billing"] = "billing";
+    AdminPermissions["Inventory"] = "inventory";
 })(AdminPermissions = exports.AdminPermissions || (exports.AdminPermissions = {}));
 var GroupConfigKey;
 (function (GroupConfigKey) {

package/models/Inventory/Item/index.d.ts

@@ -0,0 +1,33 @@
+import Model, { DocumentModel } from '../../Model';
+import { InventoryItemAssignmentKind, InventoryItemData, InventoryItemStatus } from './types';
+export default class InventoryItem extends Model<InventoryItemData> {
+    constructor(doc: DocumentModel);
+    get title(): string;
+    get typeId(): string;
+    get assignedToKind(): InventoryItemAssignmentKind | null;
+    get assignedToMemberId(): string | null;
+    get assignedToOtherLabel(): string | null;
+    get assignedAt(): FirebaseFirestore.Timestamp | null;
+    get isAssigned(): boolean;
+    get isAssignedToMember(): boolean;
+    get isAssignedToOther(): boolean;
+    get assignedHistory(): {
+        memberId: string | null;
+        otherLabel: string | null;
+        assignedAt: FirebaseFirestore.Timestamp | null;
+        returnedAt: FirebaseFirestore.Timestamp | null;
+    }[];
+    get status(): InventoryItemStatus;
+    get isAvailable(): boolean;
+    get isOnHold(): boolean;
+    get isRetired(): boolean;
+    get fieldValues(): Record<string, import("./types").InventoryItemCustomFieldValue>;
+    get createdAt(): FirebaseFirestore.Timestamp;
+    get createdBy(): string;
+    get updatedAt(): FirebaseFirestore.Timestamp;
+    get updatedBy(): string;
+    get deletedAt(): FirebaseFirestore.Timestamp | null;
+    get isDeleted(): boolean;
+    get isActive(): boolean;
+    get thumbnailURL(): string | null;
+}

package/models/Inventory/Item/index.js

@@ -0,0 +1,83 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const lodash_1 = require("lodash");
+const Model_1 = __importDefault(require("../../Model"));
+const types_1 = require("./types");
+class InventoryItem extends Model_1.default {
+    constructor(doc) {
+        super(doc);
+    }
+    get title() {
+        return this.data.title || '';
+    }
+    get typeId() {
+        return this.data.typeId;
+    }
+    get assignedToKind() {
+        return this.data.assignedToKind || null;
+    }
+    get assignedToMemberId() {
+        return this.data.assignedToMemberId || null;
+    }
+    get assignedToOtherLabel() {
+        return this.data.assignedToOtherLabel || null;
+    }
+    get assignedAt() {
+        return this.data.assignedAt || null;
+    }
+    get isAssigned() {
+        return !(0, lodash_1.isNull)(this.assignedToKind);
+    }
+    get isAssignedToMember() {
+        return this.assignedToKind === types_1.InventoryItemAssignmentKind.Member;
+    }
+    get isAssignedToOther() {
+        return this.assignedToKind === types_1.InventoryItemAssignmentKind.Other;
+    }
+    get assignedHistory() {
+        return this.data.assignedHistory || [];
+    }
+    get status() {
+        return this.data.status || types_1.InventoryItemStatus.Available;
+    }
+    get isAvailable() {
+        return this.status === types_1.InventoryItemStatus.Available;
+    }
+    get isOnHold() {
+        return this.status === types_1.InventoryItemStatus.OnHold;
+    }
+    get isRetired() {
+        return this.status === types_1.InventoryItemStatus.Retired;
+    }
+    get fieldValues() {
+        return this.data.fieldValues || {};
+    }
+    get createdAt() {
+        return this.data.createdAt;
+    }
+    get createdBy() {
+        return this.data.createdBy;
+    }
+    get updatedAt() {
+        return this.data.updatedAt;
+    }
+    get updatedBy() {
+        return this.data.updatedBy;
+    }
+    get deletedAt() {
+        return this.data.deletedAt || null;
+    }
+    get isDeleted() {
+        return !this.exists || !(0, lodash_1.isNull)(this.deletedAt);
+    }
+    get isActive() {
+        return !this.isDeleted;
+    }
+    get thumbnailURL() {
+        return this.data.thumbnailURL || null;
+    }
+}
+exports.default = InventoryItem;

package/models/Inventory/Item/types.d.ts

@@ -0,0 +1,38 @@
+import { Timestamp } from '@google-cloud/firestore';
+export declare enum InventoryItemStatus {
+    Available = "available",
+    Assigned = "assigned",
+    OnHold = "onHold",
+    Retired = "retired"
+}
+export declare enum InventoryItemAssignmentKind {
+    Member = "member",
+    Other = "other"
+}
+export interface InventoryItemCustomFieldValue {
+    value: string | number | boolean | Timestamp | string[] | null;
+    updatedAt: Timestamp;
+    updatedBy: string;
+}
+export interface InventoryItemData {
+    title: string;
+    typeId: string;
+    thumbnailURL: string | null;
+    assignedToKind: InventoryItemAssignmentKind | null;
+    assignedToMemberId: string | null;
+    assignedToOtherLabel: string | null;
+    assignedAt: Timestamp | null;
+    assignedHistory: {
+        memberId: string | null;
+        otherLabel: string | null;
+        assignedAt: Timestamp | null;
+        returnedAt: Timestamp | null;
+    }[];
+    status: InventoryItemStatus;
+    fieldValues: Record<string, InventoryItemCustomFieldValue>;
+    createdAt: Timestamp;
+    createdBy: string;
+    updatedAt: Timestamp;
+    updatedBy: string;
+    deletedAt: Timestamp | null;
+}

package/models/Inventory/Item/types.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InventoryItemAssignmentKind = exports.InventoryItemStatus = void 0;
+var InventoryItemStatus;
+(function (InventoryItemStatus) {
+    InventoryItemStatus["Available"] = "available";
+    InventoryItemStatus["Assigned"] = "assigned";
+    InventoryItemStatus["OnHold"] = "onHold";
+    InventoryItemStatus["Retired"] = "retired";
+})(InventoryItemStatus = exports.InventoryItemStatus || (exports.InventoryItemStatus = {}));
+var InventoryItemAssignmentKind;
+(function (InventoryItemAssignmentKind) {
+    InventoryItemAssignmentKind["Member"] = "member";
+    InventoryItemAssignmentKind["Other"] = "other";
+})(InventoryItemAssignmentKind = exports.InventoryItemAssignmentKind || (exports.InventoryItemAssignmentKind = {}));

package/models/Inventory/index.d.ts

@@ -0,0 +1,30 @@
+import Model, { DocumentModel } from '../Model';
+import { InventoryData } from './types';
+export default class Inventory extends Model<InventoryData> {
+    constructor(doc: DocumentModel);
+    get groupIds(): string[];
+    get types(): Record<string, import("./types").InventoryTypeData>;
+    get typesList(): {
+        customFields: {
+            label: string;
+            type: import("./types").InventoryTypeCustomFieldType;
+            required: boolean;
+            placeholder: string | null;
+            options: import("./types").InventoryTypeCustomFieldOption[];
+            order: number;
+            createdAt: FirebaseFirestore.Timestamp;
+            updatedAt: FirebaseFirestore.Timestamp;
+            createdBy: string;
+            updatedBy: string;
+            id: string;
+        }[];
+        name: string;
+        id: string;
+    }[];
+    get mergedIntoGroupId(): string | null;
+    get isMerged(): boolean;
+    get archivedAt(): FirebaseFirestore.Timestamp | null;
+    get isArchived(): boolean;
+    get ownerGroupId(): string;
+    get createdAt(): FirebaseFirestore.Timestamp;
+}

package/models/Inventory/index.js

@@ -0,0 +1,52 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const lodash_1 = require("lodash");
+const Model_1 = __importDefault(require("../Model"));
+class Inventory extends Model_1.default {
+    constructor(doc) {
+        super(doc);
+    }
+    get groupIds() {
+        return this.data.groupIds || [];
+    }
+    get types() {
+        return this.data.types || {};
+    }
+    get typesList() {
+        return Object.entries(this.types).map(([id, type]) => {
+            const fields = type.customFields || {};
+            return {
+                id,
+                ...type,
+                customFields: Object.entries(fields)
+                    .map(([fieldId, field]) => ({
+                    id: fieldId,
+                    ...field,
+                }))
+                    .sort((a, b) => a.order - b.order),
+            };
+        });
+    }
+    get mergedIntoGroupId() {
+        return this.data.mergedIntoGroupId || null;
+    }
+    get isMerged() {
+        return !(0, lodash_1.isNull)(this.mergedIntoGroupId);
+    }
+    get archivedAt() {
+        return this.data.archivedAt || null;
+    }
+    get isArchived() {
+        return !(0, lodash_1.isNull)(this.archivedAt);
+    }
+    get ownerGroupId() {
+        return this.data.ownerGroupId;
+    }
+    get createdAt() {
+        return this.data.createdAt;
+    }
+}
+exports.default = Inventory;

package/models/Inventory/types.d.ts

@@ -0,0 +1,47 @@
+import { Timestamp } from '@google-cloud/firestore';
+export declare enum InventoryTypeCustomFieldType {
+    TEXT = "text",
+    NUMBER = "number",
+    DATE = "date",
+    SELECT = "select",
+    LINK = "link",
+    PARAGRAPH = "paragraph",
+    ASSIGNABLE = "assignable",
+    IMAGES = "images",
+    DOCUMENT = "document"
+}
+export interface InventoryTypeCustomFieldOption {
+    id: string;
+    value: string;
+}
+export interface InventoryTypeCustomField {
+    label: string;
+    type: InventoryTypeCustomFieldType;
+    required: boolean;
+    placeholder: string | null;
+    options: InventoryTypeCustomFieldOption[];
+    order: number;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    createdBy: string;
+    updatedBy: string;
+}
+export interface AInventoryTypeCustomField extends InventoryTypeCustomField {
+    id: string;
+}
+export interface InventoryTypeData {
+    name: string;
+    customFields: Record<string, InventoryTypeCustomField>;
+}
+export interface AInventoryTypeData extends Omit<InventoryTypeData, 'customFields'> {
+    id: string;
+    customFields: AInventoryTypeCustomField[];
+}
+export interface InventoryData {
+    groupIds: string[];
+    types: Record<string, InventoryTypeData>;
+    mergedIntoGroupId: string | null;
+    archivedAt: Timestamp | null;
+    readonly ownerGroupId: string;
+    readonly createdAt: Timestamp;
+}

package/models/Inventory/types.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InventoryTypeCustomFieldType = void 0;
+var InventoryTypeCustomFieldType;
+(function (InventoryTypeCustomFieldType) {
+    InventoryTypeCustomFieldType["TEXT"] = "text";
+    InventoryTypeCustomFieldType["NUMBER"] = "number";
+    InventoryTypeCustomFieldType["DATE"] = "date";
+    InventoryTypeCustomFieldType["SELECT"] = "select";
+    InventoryTypeCustomFieldType["LINK"] = "link";
+    InventoryTypeCustomFieldType["PARAGRAPH"] = "paragraph";
+    InventoryTypeCustomFieldType["ASSIGNABLE"] = "assignable";
+    InventoryTypeCustomFieldType["IMAGES"] = "images";
+    InventoryTypeCustomFieldType["DOCUMENT"] = "document";
+})(InventoryTypeCustomFieldType = exports.InventoryTypeCustomFieldType || (exports.InventoryTypeCustomFieldType = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@glissandoo/lib",
-	"version": "1.108.1",
+	"version": "1.108.2",
 	"description": "Glissandoo library js",
 	"main": "./index.js",
 	"types": "./index.d.ts",