stentor-guards 1.54.6 → 1.54.12

package/lib/index.d.ts

@@ -17,3 +17,4 @@ export * from "./isSchedulableResponse";
 export * from "./isScheduled";
 export * from "./isTemplatedList";
 export * from "./isTimeContextual";
+export * from "./request";

package/lib/index.js

@@ -33,4 +33,5 @@ __exportStar(require("./isSchedulableResponse"), exports);
 __exportStar(require("./isScheduled"), exports);
 __exportStar(require("./isTemplatedList"), exports);
 __exportStar(require("./isTimeContextual"), exports);
+__exportStar(require("./request"), exports);
 //# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oCAAoC;AACpC,iDAA+B;AAC/B,mDAAiC;AACjC,qDAAmC;AACnC,qDAAmC;AACnC,gDAA8B;AAC9B,oDAAkC;AAClC,8CAA4B;AAC5B,wDAAsC;AACtC,qDAAmC;AACnC,6CAA2B;AAC3B,iDAA+B;AAC/B,yDAAuC;AACvC,wDAAsC;AACtC,0DAAwC;AACxC,0DAAwC;AACxC,gDAA8B;AAC9B,oDAAkC;AAClC,qDAAmC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oCAAoC;AACpC,iDAA+B;AAC/B,mDAAiC;AACjC,qDAAmC;AACnC,qDAAmC;AACnC,gDAA8B;AAC9B,oDAAkC;AAClC,8CAA4B;AAC5B,wDAAsC;AACtC,qDAAmC;AACnC,6CAA2B;AAC3B,iDAA+B;AAC/B,yDAAuC;AACvC,wDAAsC;AACtC,0DAAwC;AACxC,0DAAwC;AACxC,gDAA8B;AAC9B,oDAAkC;AAClC,qDAAmC;AACnC,4CAA0B"}

package/lib/request/guards.d.ts

@@ -0,0 +1,115 @@
+/*! Copyright (c) 2019, XAPPmedia */
+import { AudioPlayerRequest, InputUnknownRequest, IntentRequest, LaunchRequest, OptionSelectRequest, PermissionRequest, PlaybackControlRequest, Request, RequestDependable, SessionEndedRequest, SignInRequest, SurfaceChangeRequest, SystemDependable, NotificationPermissionRequest } from "stentor-models";
+/**
+ * Check if the request is a LaunchRequest
+ *
+ * @param request
+ * @returns
+ */
+export declare function isLaunchRequest(request: Request): request is LaunchRequest;
+/**
+ * Check if the request is an InputUnknownRequest
+ *
+ * @param request - Request
+ * @returns If the request is an InputUnknown
+ */
+export declare function isInputUnknownRequest(request: Request): request is InputUnknownRequest;
+/**
+ * Check if the request is a SessionEndedRequest
+ *
+ * @param request
+ * @returns
+ */
+export declare function isSessionEndedRequest(request: Request): request is SessionEndedRequest;
+/**
+ * Check if the request is a IntentRequest
+ *
+ * @param request
+ * @returns
+ */
+export declare function isIntentRequest(request: Request): request is IntentRequest;
+/**
+ * Check if it is a PermissionGrant
+ *
+ * @param {Request} request
+ * @returns {request is PermissionGrant}
+ */
+export declare function isPermissionRequest(request: Request): request is PermissionRequest;
+/**
+ * Check if it is a NotificationPermissionGrant
+ *
+ * @param {Request} request
+ * @returns {request is PermissionGrant}
+ */
+export declare function isNotificationPermissionRequest(request: Request): request is NotificationPermissionRequest;
+/**
+ * Check if it is a SurfaceChange
+ *
+ * @param {Request} request
+ * @returns {request is SurfaceChangeRequest}
+ */
+export declare function isSurfaceRequest(request: Request): request is SurfaceChangeRequest;
+/**
+ * Check if it is a Sign
+ *
+ * @param {Request} request
+ * @returns {request is SignInRequest}
+ */
+export declare function isSignInRequest(request: Request): request is SignInRequest;
+/**
+ * Check if it is a Option Select
+ *
+ * @param {Request} request
+ * @returns {request is OptionSelectRequest}
+ */
+export declare function isOptionSelectRequest(request: Request): request is OptionSelectRequest;
+/**
+ * Check if the request is a AudioPlayerRequest
+ *
+ * @param {Request} request
+ * @returns {boolean}
+ */
+export declare function isAudioPlayerRequest(request: Request): request is AudioPlayerRequest;
+/**
+ * Check if the request is a PlaybackControlRequest
+ *
+ * @param {Request} request
+ * @returns {request is PlaybackControlRequest}
+ */
+export declare function isPlaybackControlRequest(request: Request): request is PlaybackControlRequest;
+/**
+ * Detects if the user is anonymous.
+ *
+ * Google will make a user anonymous if they don't recognize the voice.
+ *
+ * @param {Request} request
+ * @returns {boolean}
+ */
+export declare function isAnonymousUser(request: Request): boolean;
+/**
+ * Is the request a new session.
+ *
+ * @param request
+ */
+export declare function isNewSession(request: Request): boolean;
+/**
+ * Helper function to determine if the request has a sessionID.
+ *
+ * @param {Request} request
+ * @returns True if the
+ */
+export declare function hasSessionId(request: Request): request is InputUnknownRequest | IntentRequest | LaunchRequest | SessionEndedRequest | PermissionRequest;
+/**
+ * Guard to check if an object is RequestDependable
+ *
+ * @param {object} item
+ * @returns {item is RequestDependable<T>}
+ */
+export declare function isRequestDependable<T extends object>(item: object): item is RequestDependable<T>;
+/**
+ * Guard to check if an object is SystemDependable
+ *
+ * @param {object} item
+ * @returns {item is SystemDependable<T>}
+ */
+export declare function isSystemDependable<T extends object>(item: object): item is SystemDependable<T>;

package/lib/request/guards.js

@@ -0,0 +1,184 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isSystemDependable = exports.isRequestDependable = exports.hasSessionId = exports.isNewSession = exports.isAnonymousUser = exports.isPlaybackControlRequest = exports.isAudioPlayerRequest = exports.isOptionSelectRequest = exports.isSignInRequest = exports.isSurfaceRequest = exports.isNotificationPermissionRequest = exports.isPermissionRequest = exports.isIntentRequest = exports.isSessionEndedRequest = exports.isInputUnknownRequest = exports.isLaunchRequest = void 0;
+const stentor_constants_1 = require("stentor-constants");
+/**
+ * Check if the request is a LaunchRequest
+ *
+ * @param request
+ * @returns
+ */
+function isLaunchRequest(request) {
+    return !!request && request.type === stentor_constants_1.LAUNCH_REQUEST_TYPE;
+}
+exports.isLaunchRequest = isLaunchRequest;
+/**
+ * Check if the request is an InputUnknownRequest
+ *
+ * @param request - Request
+ * @returns If the request is an InputUnknown
+ */
+function isInputUnknownRequest(request) {
+    return !!request && request.type === stentor_constants_1.INPUT_UNKNOWN_REQUEST_TYPE;
+}
+exports.isInputUnknownRequest = isInputUnknownRequest;
+/**
+ * Check if the request is a SessionEndedRequest
+ *
+ * @param request
+ * @returns
+ */
+function isSessionEndedRequest(request) {
+    return !!request && request.type === stentor_constants_1.SESSION_ENDED_REQUEST_TYPE;
+}
+exports.isSessionEndedRequest = isSessionEndedRequest;
+/**
+ * Check if the request is a IntentRequest
+ *
+ * @param request
+ * @returns
+ */
+function isIntentRequest(request) {
+    return !!request && request.type === stentor_constants_1.INTENT_REQUEST_TYPE;
+}
+exports.isIntentRequest = isIntentRequest;
+/**
+ * Check if it is a PermissionGrant
+ *
+ * @param {Request} request
+ * @returns {request is PermissionGrant}
+ */
+function isPermissionRequest(request) {
+    return !!request && request.type === stentor_constants_1.PERMISSION_REQUEST_TYPE;
+}
+exports.isPermissionRequest = isPermissionRequest;
+/**
+ * Check if it is a NotificationPermissionGrant
+ *
+ * @param {Request} request
+ * @returns {request is PermissionGrant}
+ */
+function isNotificationPermissionRequest(request) {
+    return !!request && request.type === stentor_constants_1.NOTIFICATION_PERMISSION_REQUEST_TYPE;
+}
+exports.isNotificationPermissionRequest = isNotificationPermissionRequest;
+/**
+ * Check if it is a SurfaceChange
+ *
+ * @param {Request} request
+ * @returns {request is SurfaceChangeRequest}
+ */
+function isSurfaceRequest(request) {
+    return !!request && request.type === stentor_constants_1.SURFACE_CHANGE_REQUEST_TYPE;
+}
+exports.isSurfaceRequest = isSurfaceRequest;
+/**
+ * Check if it is a Sign
+ *
+ * @param {Request} request
+ * @returns {request is SignInRequest}
+ */
+function isSignInRequest(request) {
+    return !!request && request.type === stentor_constants_1.SIGN_IN_REQUEST_TYPE;
+}
+exports.isSignInRequest = isSignInRequest;
+/**
+ * Check if it is a Option Select
+ *
+ * @param {Request} request
+ * @returns {request is OptionSelectRequest}
+ */
+function isOptionSelectRequest(request) {
+    return !!request && request.type === stentor_constants_1.OPTION_SELECT_REQUEST_TYPE;
+}
+exports.isOptionSelectRequest = isOptionSelectRequest;
+/**
+ * Check if the request is a AudioPlayerRequest
+ *
+ * @param {Request} request
+ * @returns {boolean}
+ */
+function isAudioPlayerRequest(request) {
+    return !!request && request.type === stentor_constants_1.AUDIO_PLAYER_REQUEST_TYPE;
+}
+exports.isAudioPlayerRequest = isAudioPlayerRequest;
+/**
+ * Check if the request is a PlaybackControlRequest
+ *
+ * @param {Request} request
+ * @returns {request is PlaybackControlRequest}
+ */
+function isPlaybackControlRequest(request) {
+    return !!request && request.type === stentor_constants_1.PLAYBACK_CONTROL_REQUEST_TYPE;
+}
+exports.isPlaybackControlRequest = isPlaybackControlRequest;
+const EPOCH_ID_BUG_LIMIT_MS = 5000;
+const EPOCH_LENGTH = 13;
+/**
+ * Detects if the user is anonymous.
+ *
+ * Google will make a user anonymous if they don't recognize the voice.
+ *
+ * @param {Request} request
+ * @returns {boolean}
+ */
+function isAnonymousUser(request) {
+    if (!request) {
+        return false;
+    }
+    let isAnonymousUser = false;
+    const userId = request.userId;
+    if (typeof userId === "string" && userId.length > 0 && userId.startsWith("1")) {
+        const userEpoch = parseInt(userId.substr(0, EPOCH_LENGTH), 10);
+        const thisEpoch = new Date().getTime();
+        if (thisEpoch - userEpoch < EPOCH_ID_BUG_LIMIT_MS) {
+            isAnonymousUser = true;
+        }
+    }
+    return isAnonymousUser;
+}
+exports.isAnonymousUser = isAnonymousUser;
+/**
+ * Is the request a new session.
+ *
+ * @param request
+ */
+function isNewSession(request) {
+    return request.isNewSession;
+}
+exports.isNewSession = isNewSession;
+/**
+ * Helper function to determine if the request has a sessionID.
+ *
+ * @param {Request} request
+ * @returns True if the
+ */
+function hasSessionId(request) {
+    return (isInputUnknownRequest(request) ||
+        isIntentRequest(request) ||
+        isLaunchRequest(request) ||
+        isSessionEndedRequest(request) ||
+        isPermissionRequest(request));
+}
+exports.hasSessionId = hasSessionId;
+/**
+ * Guard to check if an object is RequestDependable
+ *
+ * @param {object} item
+ * @returns {item is RequestDependable<T>}
+ */
+function isRequestDependable(item) {
+    return !!item && item.requestMatch !== undefined;
+}
+exports.isRequestDependable = isRequestDependable;
+/**
+ * Guard to check if an object is SystemDependable
+ *
+ * @param {object} item
+ * @returns {item is SystemDependable<T>}
+ */
+function isSystemDependable(item) {
+    return !!item && item.systemCondition !== undefined;
+}
+exports.isSystemDependable = isSystemDependable;
+//# sourceMappingURL=guards.js.map

package/lib/request/guards.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"guards.js","sourceRoot":"","sources":["../../src/request/guards.ts"],"names":[],"mappings":";;;AAoBA,yDAY2B;AAE3B;;;;;GAKG;AACH,SAAgB,eAAe,CAAC,OAAgB;IAC5C,OAAO,CAAC,CAAC,OAAO,IAAI,OAAO,CAAC,IAAI,KAAK,uCAAmB,CAAC;AAC7D,CAAC;AAFD,0CAEC;AAED;;;;;GAKG;AACH,SAAgB,qBAAqB,CAAC,OAAgB;IAClD,OAAO,CAAC,CAAC,OAAO,IAAI,OAAO,CAAC,IAAI,KAAK,8CAA0B,CAAC;AACpE,CAAC;AAFD,sDAEC;AACD;;;;;GAKG;AACH,SAAgB,qBAAqB,CAAC,OAAgB;IAClD,OAAO,CAAC,CAAC,OAAO,IAAI,OAAO,CAAC,IAAI,KAAK,8CAA0B,CAAC;AACpE,CAAC;AAFD,sDAEC;AACD;;;;;GAKG;AACH,SAAgB,eAAe,CAAC,OAAgB;IAC5C,OAAO,CAAC,CAAC,OAAO,IAAI,OAAO,CAAC,IAAI,KAAK,uCAAmB,CAAC;AAC7D,CAAC;AAFD,0CAEC;AACD;;;;;GAKG;AACH,SAAgB,mBAAmB,CAAC,OAAgB;IAChD,OAAO,CAAC,CAAC,OAAO,IAAI,OAAO,CAAC,IAAI,KAAK,2CAAuB,CAAC;AACjE,CAAC;AAFD,kDAEC;AACD;;;;;GAKG;AACH,SAAgB,+BAA+B,CAAC,OAAgB;IAC5D,OAAO,CAAC,CAAC,OAAO,IAAI,OAAO,CAAC,IAAI,KAAK,wDAAoC,CAAC;AAC9E,CAAC;AAFD,0EAEC;AACD;;;;;GAKG;AACH,SAAgB,gBAAgB,CAAC,OAAgB;IAC7C,OAAO,CAAC,CAAC,OAAO,IAAI,OAAO,CAAC,IAAI,KAAK,+CAA2B,CAAC;AACrE,CAAC;AAFD,4CAEC;AACD;;;;;GAKG;AACH,SAAgB,eAAe,CAAC,OAAgB;IAC5C,OAAO,CAAC,CAAC,OAAO,IAAI,OAAO,CAAC,IAAI,KAAK,wCAAoB,CAAC;AAC9D,CAAC;AAFD,0CAEC;AACD;;;;;GAKG;AACH,SAAgB,qBAAqB,CAAC,OAAgB;IAClD,OAAO,CAAC,CAAC,OAAO,IAAI,OAAO,CAAC,IAAI,KAAK,8CAA0B,CAAC;AACpE,CAAC;AAFD,sDAEC;AACD;;;;;GAKG;AACH,SAAgB,oBAAoB,CAAC,OAAgB;IACjD,OAAO,CAAC,CAAC,OAAO,IAAI,OAAO,CAAC,IAAI,KAAK,6CAAyB,CAAC;AACnE,CAAC;AAFD,oDAEC;AACD;;;;;GAKG;AACH,SAAgB,wBAAwB,CAAC,OAAgB;IACrD,OAAO,CAAC,CAAC,OAAO,IAAI,OAAO,CAAC,IAAI,KAAK,iDAA6B,CAAC;AACvE,CAAC;AAFD,4DAEC;AAED,MAAM,qBAAqB,GAAG,IAAI,CAAC;AACnC,MAAM,YAAY,GAAG,EAAE,CAAC;AAExB;;;;;;;GAOG;AACH,SAAgB,eAAe,CAAC,OAAgB;IAC5C,IAAI,CAAC,OAAO,EAAE;QACV,OAAO,KAAK,CAAC;KAChB;IAED,IAAI,eAAe,GAAG,KAAK,CAAC;IAC5B,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAE9B,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,IAAI,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;QAC3E,MAAM,SAAS,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,YAAY,CAAC,EAAE,EAAE,CAAC,CAAC;QAC/D,MAAM,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;QAEvC,IAAI,SAAS,GAAG,SAAS,GAAG,qBAAqB,EAAE;YAC/C,eAAe,GAAG,IAAI,CAAC;SAC1B;KACJ;IAED,OAAO,eAAe,CAAC;AAC3B,CAAC;AAlBD,0CAkBC;AAED;;;;GAIG;AACH,SAAgB,YAAY,CAAC,OAAgB;IACzC,OAAO,OAAO,CAAC,YAAY,CAAC;AAChC,CAAC;AAFD,oCAEC;AAED;;;;;GAKG;AACH,SAAgB,YAAY,CACxB,OAAgB;IAEhB,OAAO,CACH,qBAAqB,CAAC,OAAO,CAAC;QAC9B,eAAe,CAAC,OAAO,CAAC;QACxB,eAAe,CAAC,OAAO,CAAC;QACxB,qBAAqB,CAAC,OAAO,CAAC;QAC9B,mBAAmB,CAAC,OAAO,CAAC,CAC/B,CAAC;AACN,CAAC;AAVD,oCAUC;AACD;;;;;GAKG;AACH,SAAgB,mBAAmB,CAAmB,IAAY;IAC9D,OAAO,CAAC,CAAC,IAAI,IAAK,IAAyB,CAAC,YAAY,KAAK,SAAS,CAAC;AAC3E,CAAC;AAFD,kDAEC;AACD;;;;;GAKG;AACH,SAAgB,kBAAkB,CAAmB,IAAY;IAC7D,OAAO,CAAC,CAAC,IAAI,IAAK,IAAwB,CAAC,eAAe,KAAK,SAAS,CAAC;AAC7E,CAAC;AAFD,gDAEC"}

package/lib/request/index.d.ts

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

package/lib/request/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (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 });
+/*! Copyright (c) 2022, XAPPmedia */
+__exportStar(require("./guards"), exports);
+//# sourceMappingURL=index.js.map

package/lib/request/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/request/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oCAAoC;AACpC,2CAAyB"}

package/package.json

@@ -4,7 +4,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.54.6",
+  "version": "1.54.12",
   "description": "Common type guards for 📣 stentor",
   "types": "lib/index",
   "main": "lib/index",
@@ -23,12 +23,12 @@
     "mocha": "9.2.2",
     "sinon": "13.0.1",
     "sinon-chai": "3.7.0",
-    "stentor-models": "1.54.6",
+    "stentor-models": "1.54.12",
     "ts-node": "10.7.0",
-    "typescript": "4.6.2"
+    "typescript": "4.6.3"
   },
   "dependencies": {
-    "stentor-constants": "1.54.6"
+    "stentor-constants": "1.54.12"
   },
   "peerDependencies": {
     "stentor-models": "1.x"
@@ -38,5 +38,5 @@
     "clean": "rm -rf ./lib/* ",
     "test": "mocha --recursive -r ts-node/register \"./src/**/*.test.ts\""
   },
-  "gitHead": "a7abb20cf2d8970d6ccf665d2f502fef3a40b8f0"
+  "gitHead": "1a3c457eb1ffaafac05991ede1a4b7e0f3146ab0"
 }