@azure/notification-hubs 1.0.0-beta.1

package/types/src/utils/utils.d.ts

@@ -0,0 +1,65 @@
+/**
+ * Helper TypeGuard that checks if something is defined or not.
+ * @param thing - Anything
+ * @internal
+ */
+export declare function isDefined<T>(thing: T | undefined | null): thing is T;
+/**
+ * Helper TypeGuard that checks if something is a string or not.
+ * @param thing - Anything
+ * @internal
+ */
+export declare function isString(thing: unknown): thing is string;
+/**
+ * @internal
+ * Helper utility to retrieve `string` value from given string,
+ * or throws error if undefined.
+ */
+export declare function getString(value: unknown, nameOfProperty: string): string;
+/**
+ * @internal
+ * Helper utility to retrieve `string` value from given input,
+ * or undefined if not passed in.
+ */
+export declare function getStringOrUndefined(value: any): string | undefined;
+/**
+ * @internal
+ * Helper utility to retrieve `integer` value from given string,
+ * or throws error if undefined.
+ */
+export declare function getInteger(value: unknown, nameOfProperty: string): number;
+/**
+ * @internal
+ * Helper utility to retrieve `integer` value from given string,
+ * or undefined if not passed in.
+ */
+export declare function getIntegerOrUndefined(value: any): number | undefined;
+/**
+ * @internal
+ * Helper utility to retrieve `float` value from given string,
+ * or throws error if undefined.
+ */
+export declare function getFloat(value: unknown, nameOfProperty: string): number;
+/**
+ * @internal
+ * Helper utility to retrieve `float` value from given string,
+ * or undefined if not passed in.
+ */
+export declare function getFloatOrUndefined(value: any): number | undefined;
+/**
+ * @internal
+ * Helper utility to convert ISO-8601 time into Date type.
+ */
+export declare function getDate(value: string, nameOfProperty: string): Date;
+/**
+ * @internal
+ * Helper utility to convert ISO-8601 time into Date type,
+ * or undefined if not passed in.
+ */
+export declare function getDateOrUndefined(value: any): Date | undefined;
+/**
+ * @internal
+ * Helper utility to parse tags from a comma separated string.
+ */
+export declare function getTagsOrUndefined(value?: any): string[] | undefined;
+//# sourceMappingURL=utils.d.ts.map

package/types/src/utils/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/utils/utils.ts"],"names":[],"mappings":"AAGA;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,SAAS,GAAG,IAAI,GAAG,KAAK,IAAI,CAAC,CAEpE;AAED;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAExD;AAED;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,GAAG,MAAM,CAQxE;AAED;;;;GAIG;AAEH,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,GAAG,GAAG,MAAM,GAAG,SAAS,CAKnE;AAED;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,GAAG,MAAM,CAQzE;AAED;;;;GAIG;AAEH,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,GAAG,GAAG,MAAM,GAAG,SAAS,CAMpE;AAED;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,KAAK,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,GAAG,MAAM,CAQvE;AAED;;;;GAIG;AAEH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,GAAG,GAAG,MAAM,GAAG,SAAS,CAMlE;AAED;;;GAGG;AACH,wBAAgB,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,GAAG,IAAI,CAQnE;AAED;;;;GAIG;AAEH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,GAAG,GAAG,IAAI,GAAG,SAAS,CAO/D;AAED;;;GAGG;AAEH,wBAAgB,kBAAkB,CAAC,KAAK,CAAC,EAAE,GAAG,GAAG,MAAM,EAAE,GAAG,SAAS,CAMpE"}

package/types/src/utils/xmlUtils.d.ts

@@ -0,0 +1,46 @@
+/**
+ * Marker for atom metadata.
+ *
+ * @internal
+ */
+export declare const XML_METADATA_MARKER = "$";
+/**
+ * Marker for atom value.
+ *
+ * @internal
+ */
+export declare const XML_VALUE_MARKER = "_";
+/**
+ * @internal
+ * Returns `true` if given input is a JSON like object.
+ */
+export declare function isJSONLikeObject(value: any): boolean;
+/**
+ * @internal
+ * The key-value pairs having undefined/null as the values would lead to the empty tags in the serialized XML request.
+ * Empty tags in the request body is problematic because of the following reasons.
+ * - ATOM based management operations throw a "Bad Request" error if empty tags are included in the XML request body at top level.
+ * - At the inner levels, Service assigns the empty strings as values to the empty tags instead of throwing an error.
+ *
+ * This method recursively removes the key-value pairs with undefined/null as the values from the request object that is to be serialized.
+ *
+ */
+export declare function sanitizeSerializableObject(resource: {
+    [key: string]: any;
+}): void;
+/**
+ * @internal
+ * Serializes input information to construct the Atom XML request
+ * @param resourceName - Name of the resource to be serialized like `QueueDescription`
+ * @param resource - The entity details
+ * @returns An object to be serialized into a string.
+ */
+export declare function serializeToAtomXmlRequest(resourceName: string, resource: unknown): Record<string, unknown>;
+/**
+ * @internal
+ * Parses the XML message from a Notification Hubs response
+ * @param bodyText - The HTTP response body.
+ * @returns The notification details if any from the XML.
+ */
+export declare function parseXMLError(bodyText: string): Promise<string | undefined>;
+//# sourceMappingURL=xmlUtils.d.ts.map

package/types/src/utils/xmlUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"xmlUtils.d.ts","sourceRoot":"","sources":["../../../src/utils/xmlUtils.ts"],"names":[],"mappings":"AAMA;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,MAAM,CAAC;AAEvC;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,MAAM,CAAC;AAQpC;;;GAGG;AAEH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,GAAG,GAAG,OAAO,CAcpD;AAED;;;;;;;;;GASG;AACH,wBAAgB,0BAA0B,CAAC,QAAQ,EAAE;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CAAE,GAAG,IAAI,CAQjF;AAED;;;;;;GAMG;AACH,wBAAgB,yBAAyB,CACvC,YAAY,EAAE,MAAM,EACpB,QAAQ,EAAE,OAAO,GAChB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAoBzB;AAED;;;;;GAKG;AACH,wBAAsB,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CASjF"}