@tryghost/jsonapi-mapper 1.0.0

package/types/bookshelf/utils.d.ts

@@ -0,0 +1,26 @@
+/**
+ * The main purpose of this module is to provide utility functions
+ * that follows the restrictions of the Bookshelf/Mapper/Serializer APIs
+ * with the goal of simplifying the logic of the main 'map' method.
+ */
+import { LinkOpts } from '../interfaces';
+import { SerialOpts } from '../serializer';
+import { BookOpts, Data } from './extras';
+/**
+ * Main structure used through most utility and recursive functions
+ */
+export interface Information {
+    bookOpts: BookOpts;
+    linkOpts: LinkOpts;
+}
+/**
+ * Start the data processing with top level information,
+ * then handle resources recursively in processSample
+ */
+export declare function processData(info: Information, data: Data): SerialOpts;
+/**
+ * Convert a bookshelf model or collection to
+ * json adding the id attribute if missing
+ */
+export declare function toJSON(data: Data): any;
+//# sourceMappingURL=utils.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/bookshelf/utils.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AA2BH,OAAO,EAAE,QAAQ,EAAgB,MAAM,eAAe,CAAC;AACvD,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAG3C,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAgC,MAAM,UAAU,CAAC;AAExE;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,QAAQ,EAAE,QAAQ,CAAC;IACnB,QAAQ,EAAE,QAAQ,CAAC;CACpB;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,IAAI,GAAG,UAAU,CAWrE;AAsLD;;;GAGG;AACH,wBAAgB,MAAM,CAAC,IAAI,EAAE,IAAI,GAAG,GAAG,CAgCtC"}

package/types/index.d.ts

@@ -0,0 +1,4 @@
+export * from './bookshelf';
+export * from './interfaces';
+export * from './serializer';
+//# sourceMappingURL=index.d.ts.map

package/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC"}

package/types/interfaces/common.d.ts

@@ -0,0 +1,24 @@
+import { PagOpts, QueryOpts } from './links';
+import { RelationTypeOpt, RelationOpts } from './relations';
+export interface Mapper {
+    map(data: any, type: string, mapOpts?: MapOpts): any;
+}
+export type AttrMatcher = RegExp | string;
+export type AttributesOpt = {
+    omit?: AttrMatcher[];
+    include?: AttrMatcher[];
+};
+export interface MapOpts {
+    attributes?: AttrMatcher[] | AttributesOpt;
+    keyForAttr?: (attr: string) => string;
+    relations?: boolean | RelationOpts;
+    typeForModel?: RelationTypeOpt;
+    enableLinks?: boolean;
+    pagination?: PagOpts;
+    query?: QueryOpts;
+    meta?: {
+        [key: string]: any;
+    };
+    outputVirtuals?: boolean;
+}
+//# sourceMappingURL=common.d.ts.map

package/types/interfaces/common.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../src/interfaces/common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAC7C,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAK5D,MAAM,WAAW,MAAM;IACrB,GAAG,CAAC,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,GAAG,CAAC;CACtD;AAED,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,MAAM,CAAC;AAE1C,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,CAAC,EAAE,WAAW,EAAE,CAAC;IACrB,OAAO,CAAC,EAAE,WAAW,EAAE,CAAA;CACxB,CAAC;AAGF,MAAM,WAAW,OAAO;IAEtB,UAAU,CAAC,EAAE,WAAW,EAAE,GAAG,aAAa,CAAC;IAC3C,UAAU,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC;IAGtC,SAAS,CAAC,EAAE,OAAO,GAAG,YAAY,CAAC;IACnC,YAAY,CAAC,EAAE,eAAe,CAAC;IAG/B,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,KAAK,CAAC,EAAE,SAAS,CAAC;IAGlB,IAAI,CAAC,EAAE;QAAE,CAAC,GAAG,EAAC,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;IAG7B,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B"}

package/types/interfaces/index.d.ts

@@ -0,0 +1,4 @@
+export * from './common';
+export * from './links';
+export * from './relations';
+//# sourceMappingURL=index.d.ts.map

package/types/interfaces/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/interfaces/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,aAAa,CAAC"}

package/types/interfaces/links.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Query Parameters map
+ */
+export interface QueryOpts {
+    [key: string]: string;
+}
+/**
+ * Pagination variables
+ */
+export interface PagOpts {
+    offset: number;
+    limit: number;
+    total?: number;
+    rowCount?: number;
+}
+/**
+ * Data required to form links
+ */
+export interface LinkOpts {
+    baseUrl: string;
+    type: string;
+    pag?: PagOpts;
+    query?: QueryOpts;
+}
+//# sourceMappingURL=links.d.ts.map

package/types/interfaces/links.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"links.d.ts","sourceRoot":"","sources":["../../src/interfaces/links.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,KAAK,CAAC,EAAE,SAAS,CAAC;CACnB"}

package/types/interfaces/relations.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Map to specify type for the passed relations
+ */
+export interface RelationTypeMap {
+    [relationName: string]: string;
+}
+/**
+ * Function to pass directly as the typeForAttributes option to the serializer
+ */
+export type RelationTypeFunction = (attribute: string) => string;
+/**
+ * The relationTypes option can be a function or an object
+ */
+export type RelationTypeOpt = RelationTypeMap | RelationTypeFunction;
+/**
+ * Relationship options
+ */
+export interface RelationOpts {
+    included: boolean | string[];
+    fields?: string[];
+}
+//# sourceMappingURL=relations.d.ts.map

package/types/interfaces/relations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"relations.d.ts","sourceRoot":"","sources":["../../src/interfaces/relations.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,CAAC,SAAS,EAAE,MAAM,KAAK,MAAM,CAAC;AAEjE;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,eAAe,GAAG,oBAAoB,CAAC;AAErE;;GAEG;AACH,MAAM,WAAW,YAAY;IACzB,QAAQ,EAAE,OAAO,GAAG,MAAM,EAAE,CAAC;IAC7B,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACrB"}

package/types/serializer/index.d.ts

@@ -0,0 +1,34 @@
+export type LinkFunc = (primary: any, related?: any, parent?: any) => string;
+export type Link = string | LinkFunc;
+export interface LinkObj {
+    self?: Link;
+    related?: Link;
+    first?: Link;
+    last?: Link;
+    prev?: Link;
+    next?: Link;
+}
+export interface SerialOpts {
+    attributes?: string[];
+    ref?: string;
+    included?: boolean;
+    topLevelLinks?: LinkObj;
+    dataLinks?: LinkObj;
+    relationshipLinks?: LinkObj;
+    includedLinks?: LinkObj;
+    relationshipMeta?: any;
+    ignoreRelationshipData?: boolean;
+    keyForAttribute?: (attribute: any) => string;
+    typeForAttribute?: (attribute: any) => any;
+    pluralizeType?: boolean;
+    meta?: any;
+    [relationships: string]: any;
+}
+export interface SerializerCtor {
+    new (type: string, opts: SerialOpts): Serializer;
+}
+export interface Serializer {
+    serialize(data: any): any;
+}
+export declare let Serializer: SerializerCtor;
+//# sourceMappingURL=index.d.ts.map

package/types/serializer/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/serializer/index.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,QAAQ,GAAG,CAAC,OAAO,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,GAAG,EAAE,MAAM,CAAC,EAAE,GAAG,KAAK,MAAM,CAAC;AAE7E,MAAM,MAAM,IAAI,GAAG,MAAM,GAAG,QAAQ,CAAC;AAErC,MAAM,WAAW,OAAO;IACtB,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,OAAO,CAAC,EAAE,IAAI,CAAC;IAEf,KAAK,CAAC,EAAE,IAAI,CAAC;IACb,IAAI,CAAC,EAAE,IAAI,CAAC;IAEZ,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,IAAI,CAAC,EAAE,IAAI,CAAC;CACb;AAED,MAAM,WAAW,UAAU;IACzB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB,gBAAgB,CAAC,EAAE,GAAG,CAAC;IACvB,sBAAsB,CAAC,EAAE,OAAO,CAAC;IAEjC,eAAe,CAAC,EAAE,CAAC,SAAS,EAAE,GAAG,KAAK,MAAM,CAAC;IAC7C,gBAAgB,CAAC,EAAE,CAAC,SAAS,EAAE,GAAG,KAAK,GAAG,CAAC;IAC3C,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB,IAAI,CAAC,EAAE,GAAG,CAAC;IAGX,CAAC,aAAa,EAAE,MAAM,GAAG,GAAG,CAAC;CAC9B;AAED,MAAM,WAAW,cAAc;IAC7B,KAAI,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,GAAG,UAAU,CAAC;CACjD;AAED,MAAM,WAAW,UAAU;IACzB,SAAS,CAAC,IAAI,EAAE,GAAG,GAAG,GAAG,CAAC;CAC3B;AAGD,eAAO,IAAI,UAAU,EAAE,cAA+B,CAAC"}