@adobe/spacecat-shared-data-access 1.59.2 → 1.60.0

package/src/v2/models/import-url/index.d.ts

@@ -0,0 +1,35 @@
+/*
+ * Copyright 2024 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+
+import type { BaseCollection, BaseModel } from '../base';
+
+export interface ImportUrl extends BaseModel {
+  getExpiresAt(): number,
+  getFile(): string,
+  getImportJobId(): string,
+  getPath(): string,
+  getReason(): string,
+  getStatus(): string,
+  getUrl(): string,
+  setExpiresAt(expiresAt: number): void,
+  setFile(file: string): void,
+  setImportJobId(importJobId: string): void,
+  setPath(path: string): void,
+  setReason(reason: string): void,
+  setStatus(status: string): void,
+  setUrl(url: string): void,
+}
+
+export interface ImportUrlCollection extends BaseCollection<ImportUrl> {
+  allByImportJobId(importJobId: string): Promise<ImportUrl[]>;
+  allByImportUrlsByJobIdAndStatus(importJobId: string, status: string): Promise<ImportUrl[]>;
+}

package/src/v2/models/import-url/index.js

@@ -0,0 +1,19 @@
+/*
+ * Copyright 2024 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+
+import ImportUrl from './import-url.model.js';
+import ImportUrlCollection from './import-url.collection.js';
+
+export {
+  ImportUrl,
+  ImportUrlCollection,
+};

package/src/v2/models/index.d.ts

@@ -10,102 +10,14 @@
  * governing permissions and limitations under the License.
  */
 
-import type { ValidationError } from '../index.d.ts';
-
-/**
- * Interface representing a base model for interacting with a data entity.
- */
-export interface BaseModel {
-  getId(): string;
-  getCreatedAt(): string;
-  getUpdatedAt(): string;
-  remove(): Promise<this>;
-  save(): Promise<this>;
-}
-
-export interface MultiStatusCreateResult<T> {
-  createdItems: T[],
-  errorItems: { item: object, error: ValidationError }[],
-}
-
-/**
- * Interface representing an Opportunity model, extending BaseModel.
- */
-export interface Opportunity extends BaseModel { /* eslint-disable no-use-before-define */
-  addSuggestions(suggestions: object[]): Promise<MultiStatusCreateResult<Suggestion>>;
-  // eslint-disable-next-line no-use-before-define
-  getSuggestions(): Promise<Suggestion[]>;
-  getSiteId(): string;
-  setSiteId(siteId: string): Opportunity;
-  getAuditId(): string;
-  setAuditId(auditId: string): Opportunity;
-  getRunbook(): string;
-  setRunbook(runbook: string): Opportunity;
-  getGuidance(): string;
-  setGuidance(guidance: string): Opportunity;
-  getTitle(): string;
-  setTitle(title: string): Opportunity;
-  getDescription(): string;
-  setDescription(description: string): Opportunity;
-  getType(): string;
-  getStatus(): string;
-  setStatus(status: string): Opportunity;
-  getOrigin(): string;
-  setOrigin(origin: string): Opportunity;
-  getTags(): string[];
-  setTags(tags: string[]): Opportunity;
-  getData(): object;
-  setData(data: object): Opportunity;
-}
-
-/**
- * Interface representing a Suggestion model, extending BaseModel.
- */
-export interface Suggestion extends BaseModel {
-  getOpportunity(): Promise<Opportunity>;
-  getOpportunityId(): string;
-  setOpportunityId(opportunityId: string): Suggestion;
-  getType(): string;
-  getStatus(): string;
-  setStatus(status: string): Suggestion;
-  getRank(): number;
-  setRank(rank: number): Suggestion;
-  getData(): object;
-  setData(data: object): Suggestion;
-  getKpiDeltas(): object;
-  setKpiDeltas(kpiDeltas: object): Suggestion;
-}
-
-/**
- * Interface representing a base collection for interacting with data entities.
- */
-export interface BaseCollection<T extends BaseModel> {
-  findById(id: string): Promise<T>;
-  findByIndexKeys(indexKeys: object): Promise<T[]>;
-  create(item: object): Promise<T>;
-  createMany(items: object[]): Promise<MultiStatusCreateResult<T>>;
-}
-
-/**
- * Interface representing the Opportunity collection, extending BaseCollection.
- */
-export interface OpportunityCollection extends BaseCollection<Opportunity> {
-  allBySiteId(siteId: string): Promise<Opportunity[]>;
-  allBySiteIdAndStatus(siteId: string, status: string): Promise<Opportunity[]>;
-}
-
-/**
- * Interface representing the Suggestion collection, extending BaseCollection.
- */
-export interface SuggestionCollection extends BaseCollection<Suggestion> {
-  allByOpportunityId(opportunityId: string): Promise<Suggestion[]>;
-  allByOpportunityIdAndStatus(opportunityId: string, status: string): Promise<Suggestion[]>;
-  bulkUpdateStatus(suggestions: Suggestion[], status: string): Promise<Suggestion[]>;
-}
-
-/**
- * Interface representing the Model Factory for creating and managing model collections.
- */
-export interface ModelFactory {
-  getCollection<T extends BaseModel>(collectionName: string): BaseCollection<T>;
-}
+export type * from './audit/index.d.ts';
+export type * from './configuration/index.d.ts';
+export type * from './base/index.d.ts';
+export type * from './experiment/index.d.ts';
+export type * from './key-event/index.d.ts';
+export type * from './opportunity/index.d.ts';
+export type * from './organization/index.d.ts';
+export type * from './site/index.d.ts';
+export type * from './site-candidate/index.d.ts';
+export type * from './site-top-page/index.d.ts';
+export type * from './suggestion/index.d.ts';

package/src/v2/models/index.js

@@ -10,18 +10,17 @@
  * governing permissions and limitations under the License.
  */
 
-import ModelFactory from './model.factory.js';
-import BaseModel from './base.model.js';
-import Opportunity from './opportunity.model.js';
-import OpportunityCollection from './opportunity.collection.js';
-import Suggestion from './suggestion.model.js';
-import SuggestionCollection from './suggestion.collection.js';
-
-export {
-  ModelFactory,
-  BaseModel,
-  Opportunity,
-  OpportunityCollection,
-  Suggestion,
-  SuggestionCollection,
-};
+export * from './api-key/index.js';
+export * from './audit/index.js';
+export * from './base/index.js';
+export * from './configuration/index.js';
+export * from './experiment/index.js';
+export * from './import-job/index.js';
+export * from './import-url/index.js';
+export * from './key-event/index.js';
+export * from './opportunity/index.js';
+export * from './organization/index.js';
+export * from './site-candidate/index.js';
+export * from './site-top-page/index.js';
+export * from './site/index.js';
+export * from './suggestion/index.js';

package/src/v2/models/key-event/index.d.ts

@@ -0,0 +1,28 @@
+/*
+ * Copyright 2024 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+
+import type { BaseCollection, BaseModel } from '../index';
+
+export interface KeyEvent extends BaseModel {
+  getName(): string;
+  getSiteId(): string;
+  getTime(): number;
+  getType(): string;
+  setName(name: string): KeyEvent;
+  setSiteId(siteId: string): KeyEvent;
+  setTime(time: number): KeyEvent;
+  setType(type: string): KeyEvent;
+}
+
+export interface KeyEventCollection extends BaseCollection<KeyEvent> {
+  allBySiteId(siteId: string): Promise<KeyEvent[]>;
+}

package/src/v2/models/key-event/index.js

@@ -0,0 +1,19 @@
+/*
+ * Copyright 2024 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+
+import KeyEvent from './key-event.model.js';
+import KeyEventCollection from './key-event.collection.js';
+
+export {
+  KeyEvent,
+  KeyEventCollection,
+};

package/src/v2/models/key-event/key-event.collection.js

@@ -0,0 +1,26 @@
+/*
+ * Copyright 2024 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+
+import BaseCollection from '../base/base.collection.js';
+
+/**
+ * KeyEventCollection - A collection class responsible for managing KeyEvent entities.
+ * Extends the BaseCollection to provide specific methods for interacting with KeyEvent records.
+ *
+ * @class KeyEventCollection
+ * @extends BaseCollection
+ */
+class KeyEventCollection extends BaseCollection {
+  // add custom methods here
+}
+
+export default KeyEventCollection;

package/src/v2/models/key-event/key-event.model.js

@@ -0,0 +1,37 @@
+/*
+ * Copyright 2024 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+
+import BaseModel from '../base/base.model.js';
+
+export const KEY_EVENT_TYPES = {
+  PERFORMANCE: 'PERFORMANCE',
+  SEO: 'SEO',
+  CONTENT: 'CONTENT',
+  CODE: 'CODE',
+  THIRD_PARTY: 'THIRD PARTY',
+  EXPERIMENTATION: 'EXPERIMENTATION',
+  NETWORK: 'NETWORK',
+  STATUS_CHANGE: 'STATUS CHANGE',
+};
+
+/**
+ * KeyEvent - A class representing an KeyEvent entity.
+ * Provides methods to access and manipulate KeyEvent-specific data.
+ *
+ * @class KeyEvent
+ * @extends BaseModel
+ */
+class KeyEvent extends BaseModel {
+  // add your custom methods or overrides here
+}
+
+export default KeyEvent;

package/src/v2/models/key-event/key-event.schema.js

@@ -0,0 +1,45 @@
+/*
+ * Copyright 2024 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+
+/* c8 ignore start */
+
+import { hasText, isIsoDate } from '@adobe/spacecat-shared-utils';
+
+import SchemaBuilder from '../base/schema.builder.js';
+import { KEY_EVENT_TYPES } from '../../../models/key-event.js';
+import KeyEvent from './key-event.model.js';
+import KeyEventCollection from './key-event.collection.js';
+
+/*
+Schema Doc: https://electrodb.dev/en/modeling/schema/
+Attribute Doc: https://electrodb.dev/en/modeling/attributes/
+Indexes Doc: https://electrodb.dev/en/modeling/indexes/
+ */
+
+const schema = new SchemaBuilder(KeyEvent, KeyEventCollection)
+  .addReference('belongs_to', 'Site', ['time'])
+  .addAttribute('name', {
+    type: 'string',
+    required: true,
+    validate: (value) => hasText(value),
+  })
+  .addAttribute('type', {
+    type: Object.values(KEY_EVENT_TYPES),
+    required: true,
+  })
+  .addAttribute('time', {
+    type: 'string',
+    required: true,
+    validate: (value) => isIsoDate(value),
+  });
+
+export default schema.build();

package/src/v2/models/opportunity/index.d.ts

@@ -0,0 +1,46 @@
+/*
+ * Copyright 2024 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+
+import type {
+  BaseCollection, BaseModel, MultiStatusCreateResult, Suggestion,
+} from '../index';
+
+export interface Opportunity extends BaseModel {
+  addSuggestions(suggestions: object[]): Promise<MultiStatusCreateResult<Suggestion>>;
+  getAuditId(): string;
+  getData(): object;
+  getDescription(): string;
+  getGuidance(): string;
+  getOrigin(): string;
+  getRunbook(): string;
+  getSiteId(): string;
+  getStatus(): string;
+  getSuggestions(): Promise<Suggestion[]>;
+  getTags(): string[];
+  getTitle(): string;
+  getType(): string;
+  setAuditId(auditId: string): Opportunity;
+  setData(data: object): Opportunity;
+  setDescription(description: string): Opportunity;
+  setGuidance(guidance: string): Opportunity;
+  setOrigin(origin: string): Opportunity;
+  setRunbook(runbook: string): Opportunity;
+  setSiteId(siteId: string): Opportunity;
+  setStatus(status: string): Opportunity;
+  setTags(tags: string[]): Opportunity;
+  setTitle(title: string): Opportunity;
+}
+
+export interface OpportunityCollection extends BaseCollection<Opportunity> {
+  allBySiteId(siteId: string): Promise<Opportunity[]>;
+  allBySiteIdAndStatus(siteId: string, status: string): Promise<Opportunity[]>;
+}

package/src/v2/models/opportunity/index.js

@@ -0,0 +1,19 @@
+/*
+ * Copyright 2024 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+
+import Opportunity from './opportunity.model.js';
+import OpportunityCollection from './opportunity.collection.js';
+
+export {
+  Opportunity,
+  OpportunityCollection,
+};

package/src/v2/models/opportunity/opportunity.collection.js

@@ -0,0 +1,26 @@
+/*
+ * Copyright 2024 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+
+import BaseCollection from '../base/base.collection.js';
+
+/**
+ * OpportunityCollection - A collection class responsible for managing Opportunity entities.
+ * Extends the BaseCollection to provide specific methods for interacting with Opportunity records.
+ *
+ * @class OpportunityCollection
+ * @extends BaseCollection
+ */
+class OpportunityCollection extends BaseCollection {
+  // add custom methods here
+}
+
+export default OpportunityCollection;

package/src/v2/models/{opportunity.model.js → opportunity/opportunity.model.js}

@@ -10,7 +10,20 @@
  * governing permissions and limitations under the License.
  */
 
-import BaseModel from './base.model.js';
+import BaseModel from '../base/base.model.js';
+
+export const ORIGINS = {
+  ESS_OPS: 'ESS_OPS',
+  AI: 'AI',
+  AUTOMATION: 'AUTOMATION',
+};
+
+export const STATUSES = {
+  NEW: 'NEW',
+  IN_PROGRESS: 'IN_PROGRESS',
+  IGNORED: 'IGNORED',
+  RESOLVED: 'RESOLVED',
+};
 
 /**
  * Opportunity - A class representing an Opportunity entity.
@@ -38,7 +51,7 @@ class Opportunity extends BaseModel {
       ...suggestion,
       [this.idName]: this.getId(),
     }));
-    return this.modelFactory
+    return this.entityRegistry
       .getCollection('SuggestionCollection')
       .createMany(childSuggestions, this);
   }

package/src/v2/models/opportunity/opportunity.schema.js

@@ -0,0 +1,69 @@
+/*
+ * Copyright 2024 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+
+/* c8 ignore start */
+
+import { isNonEmptyObject, isValidUrl } from '@adobe/spacecat-shared-utils';
+
+import SchemaBuilder from '../base/schema.builder.js';
+import Opportunity, { ORIGINS, STATUSES } from './opportunity.model.js';
+import OpportunityCollection from './opportunity.collection.js';
+
+/*
+Schema Doc: https://electrodb.dev/en/modeling/schema/
+Attribute Doc: https://electrodb.dev/en/modeling/attributes/
+Indexes Doc: https://electrodb.dev/en/modeling/indexes/
+ */
+
+const schema = new SchemaBuilder(Opportunity, OpportunityCollection)
+  .addReference('belongs_to', 'Site', ['status', 'updatedAt'])
+  .addReference('belongs_to', 'Audit', ['updatedAt'], { required: false })
+  .addReference('has_many', 'Suggestions', ['updatedAt'], { removeDependents: true })
+  .addAttribute('runbook', {
+    type: 'string',
+    validate: (value) => !value || isValidUrl(value),
+  })
+  .addAttribute('type', {
+    type: 'string',
+    readOnly: true,
+    required: true,
+  })
+  .addAttribute('data', {
+    type: 'any',
+    validate: (value) => !value || isNonEmptyObject(value),
+  })
+  .addAttribute('origin', {
+    type: Object.values(ORIGINS),
+    required: true,
+  })
+  .addAttribute('title', {
+    type: 'string',
+    required: true,
+  })
+  .addAttribute('description', {
+    type: 'string',
+  })
+  .addAttribute('status', {
+    type: Object.values(STATUSES),
+    required: true,
+    default: 'NEW',
+  })
+  .addAttribute('guidance', {
+    type: 'any',
+    validate: (value) => !value || isNonEmptyObject(value),
+  })
+  .addAttribute('tags', {
+    type: 'set',
+    items: 'string',
+  });
+
+export default schema.build();

package/src/v2/models/organization/index.d.ts

@@ -0,0 +1,28 @@
+/*
+ * Copyright 2024 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+
+import type { BaseCollection, BaseModel } from '../index';
+
+export interface Organization extends BaseModel {
+  getConfig(): object;
+  getFulfillableItems(): object;
+  getImsOrgId(): string;
+  getName(): string;
+  setConfig(config: object): Organization;
+  setFulfillableItems(fulfillableItems: object): Organization;
+  setImsOrgId(imsOrgId: string): Organization;
+  setName(name: string): Organization;
+}
+
+export interface OrganizationCollection extends BaseCollection<Organization> {
+  allByImsOrgId(imsOrgId: string): Promise<Organization[]>;
+}

package/src/v2/models/organization/index.js

@@ -0,0 +1,19 @@
+/*
+ * Copyright 2024 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+
+import Organization from './organization.model.js';
+import OrganizationCollection from './organization.collection.js';
+
+export {
+  Organization,
+  OrganizationCollection,
+};

package/src/v2/models/organization/organization.collection.js

@@ -0,0 +1,26 @@
+/*
+ * Copyright 2024 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+
+import BaseCollection from '../base/base.collection.js';
+
+/**
+ * OrganizationCollection - A collection class responsible for managing Organization entities.
+ * Extends the BaseCollection to provide specific methods for interacting with Organization records.
+ *
+ * @class OrganizationCollection
+ * @extends BaseCollection
+ */
+class OrganizationCollection extends BaseCollection {
+  // add custom methods here
+}
+
+export default OrganizationCollection;

package/src/v2/models/organization/organization.model.js

@@ -0,0 +1,31 @@
+/*
+ * Copyright 2024 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+
+import { Config } from '../../../models/site/config.js';
+import BaseModel from '../base/base.model.js';
+
+/**
+ * Organization - A class representing an Organization entity.
+ * Provides methods to access and manipulate Organization-specific data.
+ *
+ * @class Organization
+ * @extends BaseModel
+ */
+class Organization extends BaseModel {
+  // add your custom methods or overrides here
+
+  getConfig() {
+    return Config(this.record.config);
+  }
+}
+
+export default Organization;