@xapp/ovai-lib 1.18.111 → 1.18.115

package/lib/Handler/PlayPodcastHandler/Props.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Props.js","sourceRoot":"","sources":["../../../src/Handler/PlayPodcastHandler/Props.ts"],"names":[],"mappings":""}

package/lib/Handler/PlayPodcastHandler/Storage.d.ts

@@ -0,0 +1,31 @@
+/*! Copyright (c) 2019, XAPPmedia */
+import { AudioStorage } from "../AudioHandler";
+export interface PlayPodcastStorage extends AudioStorage {
+    /**
+     * Flag to remember if we asked them to play the latest.
+     *
+     * This is a candidate for session storage.
+     *
+     * @type {boolean}
+     * @memberof PlayPodcastStorage
+     */
+    askedToPlayLatest?: boolean;
+    /**
+     * Flag to remember if they are currently searching for an episode.
+     *
+     * This is a candidate for session storage.
+     *
+     * @type {boolean}
+     * @memberof PlayPodcastStorage
+     */
+    searchingForEpisode?: boolean;
+    /**
+     * The number of unsuccessful searches the user has
+     *
+     * This is a candidate for session storage.
+     *
+     * @type {number}
+     * @memberof PlayPodcastStorage
+     */
+    unsuccessfulSearches?: number;
+}

package/lib/Handler/PlayPodcastHandler/Storage.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=Storage.js.map

package/lib/Handler/PlayPodcastHandler/Storage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Storage.js","sourceRoot":"","sources":["../../../src/Handler/PlayPodcastHandler/Storage.ts"],"names":[],"mappings":""}

package/lib/Handler/PlayPodcastHandler/index.d.ts

@@ -0,0 +1,5 @@
+/*! Copyright (c) 2020, XAPPmedia */
+export * from "./Data";
+export * from "./Guards";
+export * from "./Props";
+export * from "./Storage";

package/lib/Handler/PlayPodcastHandler/index.js

@@ -0,0 +1,7 @@
+"use strict";
+function __export(m) {
+    for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
+}
+Object.defineProperty(exports, "__esModule", { value: true });
+__export(require("./Guards"));
+//# sourceMappingURL=index.js.map

package/lib/Handler/PlayPodcastHandler/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/Handler/PlayPodcastHandler/index.ts"],"names":[],"mappings":";;;;;AAEA,8BAAyB"}

package/lib/Handler/SmsHandler/Data.d.ts

@@ -0,0 +1,13 @@
+/*! Copyright (c) 2019, XAPPmedia */
+import { Data, SmsDescription } from "stentor-models";
+/**
+ *
+ */
+export interface SmsData extends Data {
+    smsTypeKey: string;
+    successContentName: string;
+    failureContentName: string;
+    sms: {
+        [smsType: string]: SmsDescription;
+    };
+}

package/lib/Handler/SmsHandler/Data.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=Data.js.map

package/lib/Handler/SmsHandler/Data.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Data.js","sourceRoot":"","sources":["../../../src/Handler/SmsHandler/Data.ts"],"names":[],"mappings":""}

package/lib/Handler/SmsHandler/Storage.d.ts

@@ -0,0 +1,6 @@
+/*! Copyright (c) 2019, XAPPmedia */
+import { Storage } from "stentor-models";
+export interface SmsStorage extends Storage {
+    unsuccessfulSmsSend?: boolean;
+    numberOfPhoneNumberQuestions?: number;
+}

package/lib/Handler/SmsHandler/Storage.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=Storage.js.map

package/lib/Handler/SmsHandler/Storage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Storage.js","sourceRoot":"","sources":["../../../src/Handler/SmsHandler/Storage.ts"],"names":[],"mappings":""}

package/lib/Handler/SmsHandler/index.d.ts

@@ -0,0 +1,3 @@
+/*! Copyright (c) 2020, XAPPmedia */
+export * from "./Data";
+export * from "./Storage";

package/lib/Handler/SmsHandler/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/lib/Handler/SmsHandler/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/Handler/SmsHandler/index.ts"],"names":[],"mappings":""}

package/lib/Handler/SocialRadioHandler/Data.d.ts

@@ -0,0 +1,33 @@
+/*! Copyright (c) 2019, XAPPmedia */
+import { AudioData } from "../AudioHandler";
+export interface PlayOnDemandData extends AudioData {
+    /**
+     * Type of on demand service, only "SocialRadio" is supported at this point.
+     *
+     * @type {"SocialRadio"}
+     * @memberof PlayOnDemandData
+     */
+    type: "SocialRadio";
+    /**
+     * API token specific for SocialRadio
+     *
+     * @deprecated Use apiToken instead
+     * @type {string}
+     * @memberof PlayOnDemandData
+     */
+    stationToken?: string;
+    /**
+     * API token for accessing the on demand API.
+     *
+     * @type {string}
+     * @memberof PlayOnDemandData
+     */
+    apiToken?: string;
+    /**
+     * Channel to play
+     *
+     * @type {string}
+     * @memberof PlayOnDemandData
+     */
+    channel?: string;
+}

package/lib/Handler/SocialRadioHandler/Data.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=Data.js.map

package/lib/Handler/SocialRadioHandler/Data.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Data.js","sourceRoot":"","sources":["../../../src/Handler/SocialRadioHandler/Data.ts"],"names":[],"mappings":""}

package/lib/Handler/SocialRadioHandler/index.d.ts

@@ -0,0 +1,2 @@
+/*! Copyright (c) 2020, XAPPmedia */
+export * from "./Data";

package/lib/Handler/SocialRadioHandler/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/lib/Handler/SocialRadioHandler/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/Handler/SocialRadioHandler/index.ts"],"names":[],"mappings":""}

package/lib/Handler/Types.d.ts

@@ -0,0 +1,10 @@
+/*! Copyright (c) 2019, XAPPmedia */
+export declare type EmailHandlerType = "EmailHandlerType";
+export declare type LogicHandlerType = "LogicHandlerType";
+export declare type MultimediaHandlerType = "MultimediaHandlerType";
+export declare type PlayLivestreamHandlerType = "PlayLiveStreamIntent";
+export declare type PlayMediaHandlerType = "PlayMediaIntent";
+export declare type PlayPodcastHandlerType = "PlayPodcastIntent";
+export declare type SmsHandlerType = "SmsHandlerType";
+export declare type PlayOnDemandHandlerType = "PlayOnDemandIntent";
+export declare type AudioHandlerType = MultimediaHandlerType | PlayLivestreamHandlerType | PlayMediaHandlerType | PlayPodcastHandlerType;

package/lib/Handler/Types.js

@@ -0,0 +1,4 @@
+"use strict";
+/*! Copyright (c) 2019, XAPPmedia */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=Types.js.map

package/lib/Handler/Types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Types.js","sourceRoot":"","sources":["../../src/Handler/Types.ts"],"names":[],"mappings":";AAAA,oCAAoC"}

package/lib/Handler/index.d.ts

@@ -0,0 +1,11 @@
+/*! Copyright (c) 2020, XAPPmedia */
+export * from "./AudioHandler";
+export * from "./Constants";
+export * from "./EmailHandler";
+export * from "./MultimediaHandler";
+export * from "./PlayLiveStreamHandler";
+export * from "./PlayMediaHandler";
+export * from "./PlayPodcastHandler";
+export * from "./SmsHandler";
+export * from "./SocialRadioHandler";
+export * from "./Types";

package/lib/Handler/index.js

@@ -0,0 +1,10 @@
+"use strict";
+function __export(m) {
+    for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
+}
+Object.defineProperty(exports, "__esModule", { value: true });
+/*! Copyright (c) 2020, XAPPmedia */
+__export(require("./AudioHandler"));
+__export(require("./Constants"));
+__export(require("./PlayPodcastHandler"));
+//# sourceMappingURL=index.js.map

package/lib/Handler/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/Handler/index.ts"],"names":[],"mappings":";;;;;AAAA,oCAAoC;AACpC,oCAA+B;AAC/B,iCAA4B;AAK5B,0CAAqC"}

package/lib/OVAIApp.d.ts

@@ -1,12 +1,30 @@
 /*! Copyright (c) 2020, XAPPmedia */
-import { App, TemplateType } from "stentor-models";
+import { App, FullAppStatus } from "stentor-models";
+import { IPRights } from "./Organization";
+import { TemplateType } from "./Template";
 export interface OVAIApp extends App {
+    /**
+     * The ID of the organization the app belongs to
+     */
+    organizationId: string;
     /**
      * Type of App
      */
     templateType?: TemplateType;
+    /**
+     * Current status of the app
+     */
+    status?: FullAppStatus;
+    /**
+     * Allows stentor_admins to view and add notes to apps for internal use
+     */
+    internalNotes?: string;
     /**
      * The subscription ID linked to the App
      */
     stripeSubscriptionId?: string;
+    /**
+     * Allows app-specific overriding of IPRights
+     */
+    ipRights?: IPRights;
 }

package/lib/Organization/Organization.d.ts

@@ -0,0 +1,135 @@
+/*! Copyright (c) 2019, XAPPmedia */
+import { TemplateType } from "../Template";
+/**
+ * A collection of accounts that are linked to the organization.
+ * The name is the type of account that is linked.
+ * The object linked is unique to the account type, so it's up to the
+ * client to know what that is.
+ */
+export interface Accounts {
+    [accountName: string]: any;
+}
+/**
+ * The IP rights documents that exist for the various platforms.
+ */
+export interface IPRights {
+    alexa?: string;
+}
+/**
+ * A Stripe account is a payment account associated with the user.
+ */
+export interface StripeAccount {
+    /**
+     * The ID of the customer in stripe that this organization is linked to.
+     */
+    customerId: string;
+}
+export interface ServiceOrderAccount {
+    /**
+     * The style of payment that the service order is a part of.
+     */
+    paymentType: string;
+    /**
+     * The number of apps that the service order allows.
+     */
+    numberOfApps?: number;
+    /**
+     * The date with which the service order was created.
+     */
+    date: string;
+}
+/**
+ * The new form of `ServiceOrderAccount#numberOfApps`.  The key is the type of template
+ * which can be found at `templates/Types`.
+ */
+export declare type ServiceOrderTemplate = Partial<Record<TemplateType, ServiceOrderAccount>>;
+/**
+ * The type for number of apps in a `ServiceOrderAccount`.
+ *
+ * The legacy parameter is a ServiceOrderAccount which represents Radio/Live stream templates only.
+ *
+ * The New Parameter is a ServiceOrderTemplate object in which the key is the service order
+ * and the object returned is the service order supplied.
+ */
+export declare type ServiceOrders = ServiceOrderAccount | ServiceOrderTemplate;
+/**
+ * A collection of accounts associated with the payment on the stentor platform.
+ */
+export interface PaymentAccounts {
+    /**
+     * The stripe account that is linked to this organization.
+     */
+    stripe?: StripeAccount;
+    /**
+     * The Service order account that is linked to this organization.
+     */
+    so?: ServiceOrders;
+}
+/**
+ * An organization is the name of organization contains a collection of groups.
+ */
+export interface Organization {
+    /**
+     * The unique identifier of the organization.
+     */
+    organizationId: string;
+    /**
+     * The public facing name of this organization.
+     */
+    name: string;
+    /**
+     * The public facing description of the group.
+     */
+    description: string;
+    /**
+     * Contact email for the organization.
+     */
+    contact?: string;
+    /**
+     * Contact name for the organization.
+     */
+    contactName?: string;
+    /**
+     * ContactPhone for the organization
+     */
+    contactPhone?: string;
+    /**
+     * Contract date
+     */
+    contractDate?: string;
+    /**
+     * Internally maintained notes for the organization
+     */
+    notes?: string;
+    /**
+     * Accounts that are linked to the organization that involve financial transactions.
+     */
+    paymentAccounts?: PaymentAccounts;
+    /**
+     * The group ID as it is in auth0.  This can be used to retrieve the permissions, roles, and nested groups that
+     * the group may contain.
+     */
+    auth0GroupId?: string;
+    /**
+     * The remote location for the organization's image.
+     */
+    logoUrl?: string;
+    /**
+     * The main website that the organization owns.
+     */
+    website?: string;
+    /**
+     * The vendorId that is used for publishing.
+     * For example, the accounts under "Smapi" will have a vendorId or
+     * other metadata needed for publishing.
+     */
+    publishingAccounts?: Accounts;
+    /**
+     * IP Rights documents that are attached to this organization.
+     */
+    ipRights?: IPRights;
+    /**
+     * Internal SME/POC
+     */
+    XAPPLead?: string;
+}

package/lib/Organization/Organization.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=Organization.js.map

package/lib/Organization/Organization.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Organization.js","sourceRoot":"","sources":["../../src/Organization/Organization.ts"],"names":[],"mappings":""}

package/lib/Organization/index.d.ts

@@ -0,0 +1,2 @@
+/*! Copyright (c) 2019, XAPPmedia */
+export * from "./Organization";

package/lib/Organization/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/lib/Organization/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/Organization/index.ts"],"names":[],"mappings":""}

package/lib/Template/Template.d.ts

@@ -0,0 +1,13 @@
+/*! Copyright (c) 2019, XAPPmedia */
+import { OVAIApp } from "../OVAIApp";
+import { TemplateType } from "./Types";
+export interface Template extends Partial<OVAIApp> {
+    /**
+     * Template type.
+     */
+    templateType: TemplateType;
+    /**
+     * The collaboration agreement between the app and XAPP.
+     */
+    collaborationAgreementUrl?: string;
+}

package/lib/Template/Template.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=Template.js.map

package/lib/Template/Template.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Template.js","sourceRoot":"","sources":["../../src/Template/Template.ts"],"names":[],"mappings":""}

package/lib/Template/Types.d.ts

@@ -0,0 +1,9 @@
+/*! Copyright (c) 2019, XAPPmedia */
+export declare type OnDemandTemplateType = "PODCAST_TEMPLATE";
+export declare type RadioTemplateType = "RADIO_TEMPLATE";
+/**
+ * Used to communicate the app is custom and does not adhere to a specific
+ * predefined template.
+ */
+export declare type CustomType = "CUSTOM";
+export declare type TemplateType = RadioTemplateType | OnDemandTemplateType | CustomType;

package/lib/Template/Types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=Types.js.map

package/lib/Template/Types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Types.js","sourceRoot":"","sources":["../../src/Template/Types.ts"],"names":[],"mappings":""}

package/lib/Template/index.d.ts

@@ -0,0 +1,3 @@
+/*! Copyright (c) 2019, XAPPmedia */
+export * from "./Template";
+export * from "./Types";

package/lib/Template/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/lib/Template/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/Template/index.ts"],"names":[],"mappings":""}

package/lib/index.d.ts

@@ -1,3 +1,8 @@
 /*! Copyright (c) 2020, XAPPmedia */
+export * from "./Contentable";
+export * from "./Handler";
+export * from "./isContentable";
+export * from "./Organization";
 export * from "./OVAIApp";
 export * from "./RadioApp";
+export * from "./Template";

package/lib/index.js

@@ -3,5 +3,7 @@ function __export(m) {
     for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
 }
 Object.defineProperty(exports, "__esModule", { value: true });
+__export(require("./Handler"));
+__export(require("./isContentable"));
 __export(require("./RadioApp"));
 //# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;AAEA,gCAA2B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;AAEA,+BAA0B;AAC1B,qCAAgC;AAGhC,gCAA2B"}

package/lib/isContentable.d.ts

@@ -0,0 +1,6 @@
+/*! Copyright (c) 2019, XAPPmedia */
+import { Contentable } from "./Contentable";
+/**
+ * Guard to check if the provided object is Contentable, it has a content key.
+ */
+export declare function isContentable(item: object): item is Contentable;

package/lib/isContentable.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Guard to check if the provided object is Contentable, it has a content key.
+ */
+function isContentable(item) {
+    return !!item && item.content !== undefined;
+}
+exports.isContentable = isContentable;
+//# sourceMappingURL=isContentable.js.map

package/lib/isContentable.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"isContentable.js","sourceRoot":"","sources":["../src/isContentable.ts"],"names":[],"mappings":";;AAGA;;GAEG;AACH,SAAgB,aAAa,CAAC,IAAY;IACtC,OAAO,CAAC,CAAC,IAAI,IAAK,IAAoB,CAAC,OAAO,KAAK,SAAS,CAAC;AACjE,CAAC;AAFD,sCAEC"}

package/package.json

@@ -4,7 +4,7 @@
   "publishConfig": {
     "access": "restricted"
   },
-  "version": "1.18.111",
+  "version": "1.18.115",
   "description": "Shared library for OVAI",
   "types": "lib/index",
   "main": "lib/index",
@@ -17,10 +17,16 @@
   "devDependencies": {
     "@types/chai": "4.2.11",
     "chai": "4.2.0",
-    "stentor-models": "1.23.27",
+    "stentor-models": "1.23.37",
     "ts-node": "8.7.0",
     "typescript": "3.8.3"
   },
+  "dependencies": {
+    "@xapp/stentor-media-manager": "1.18.112",
+    "@xapp/stentor-service-search": "1.18.115",
+    "stentor-guards": "1.23.36",
+    "stentor-media": "1.23.36"
+  },
   "peerDependencies": {
     "stentor-models": "1.x"
   },
@@ -29,5 +35,5 @@
     "clean": "rm -rf ./lib/*",
     "test": "mocha --recursive -r ts-node/register \"./src/**/*.test.ts\""
   },
-  "gitHead": "9a1ef6d126821a779016b6a6deb0c2a8ba8b08c4"
+  "gitHead": "3fb7af769207cba16cb7dac959e839ee0f20c964"
 }