@api-client/core 0.9.25 → 0.10.0

package/build/esm/src/models/HttpCookie.d.ts

@@ -0,0 +1,174 @@
+import { ARCCookie as LegacyARCCookie } from './legacy/models/Cookies.js';
+export type CookieSameSiteType = 'unspecified' | 'no_restriction' | 'lax' | 'strict';
+export type CookieChangeReason = 'explicit' | 'overwrite' | 'expired' | 'evicted' | 'expired-overwrite';
+export interface IElectronCookie {
+    name: string;
+    value: string;
+    /**
+     * The domain of the cookie; this will be normalized with a preceding dot so that it's also valid for subdomains.
+     */
+    domain?: string;
+    /**
+     * Whether the cookie is a host-only cookie; this will only be true if no domain was passed.
+     */
+    hostOnly?: boolean;
+    /**
+     * The path of the cookie.
+     */
+    path?: string;
+    secure?: boolean;
+    httpOnly?: boolean;
+    session?: boolean;
+    expirationDate?: number;
+    sameSite?: CookieSameSiteType;
+}
+export interface IHttpCookieChangeRecord {
+    /**
+     * The cookie that was changed.
+     */
+    cookie: IHttpCookie;
+    /**
+     * The cause of the change with one of the following values:
+     * - `explicit` - The cookie was changed directly by a consumer's action.
+     * - `overwrite` - The cookie was automatically removed due to an insert operation that overwrote it.
+     * - `expired` - The cookie was automatically removed as it expired.
+     * - `evicted` - The cookie was automatically evicted during garbage collection.
+     * - `expired-overwrite` - The cookie was overwritten with an already-expired expiration date.
+     */
+    cause: CookieChangeReason;
+    /**
+     * `true` if the cookie was removed, `false` otherwise.
+     */
+    removed: boolean;
+}
+export interface IHttpCookie {
+    /**
+     * The name of the cookie.
+     */
+    name: string;
+    /**
+     * The value of the cookie.
+     */
+    value: string;
+    /**
+     * The domain of the cookie; this will be normalized with a preceding dot so that
+     * it's also valid for subdomains.
+     */
+    domain?: string;
+    /**
+     * Whether the cookie is a host-only cookie; this will only be `true` if no domain
+     * was passed.
+     */
+    hostOnly?: boolean;
+    /**
+     * The path of the cookie.
+     */
+    path?: string;
+    /**
+     * Whether the cookie is marked as secure.
+     */
+    secure?: boolean;
+    /**
+     * Whether the cookie is marked as HTTP only.
+     */
+    httpOnly?: boolean;
+    /**
+     * Whether the cookie is a session cookie or a persistent cookie with an expiration
+     * date.
+     */
+    session?: boolean;
+    /**
+     * The expiration date of the cookie as the number of seconds since the UNIX epoch.
+     * Not provided for session cookies.
+     */
+    expirationDate?: number;
+    /**
+     * The Same Site policy applied to this cookie. Can be `unspecified`, `no_restriction`, `lax` or `strict`.
+     * @default unspecified
+     */
+    sameSite?: CookieSameSiteType;
+}
+export declare class HttpCookie {
+    /**
+     * The name of the cookie.
+     */
+    name: string;
+    /**
+     * The value of the cookie.
+     */
+    value: string;
+    /**
+     * Whether the cookie is a host-only cookie; this will only be `true` if no domain
+     * was passed.
+     */
+    hostOnly?: boolean;
+    /**
+     * The path of the cookie.
+     */
+    path?: string;
+    /**
+     * Whether the cookie is marked as secure.
+     */
+    secure?: boolean;
+    /**
+     * Whether the cookie is marked as HTTP only.
+     */
+    httpOnly?: boolean;
+    /**
+     * Whether the cookie is a session cookie or a persistent cookie with an expiration
+     * date.
+     */
+    session?: boolean;
+    /**
+     * The Same Site policy applied to this cookie. Can be `unspecified`, `no_restriction`, `lax` or `strict`.
+     * @default unspecified
+     */
+    sameSite: CookieSameSiteType;
+    protected _domain?: string;
+    protected _maxAge?: number;
+    protected _expirationDate?: number | undefined;
+    /**
+     * @param max The max age value
+     */
+    set maxAge(max: number | undefined);
+    /**
+     * @return Returns a value of maxAge property
+     */
+    get maxAge(): number | undefined;
+    /**
+     * The expiration date of the cookie as the number of seconds since the UNIX epoch.
+     * Not provided for session cookies.
+     */
+    set expirationDate(expires: number | Date | string | undefined);
+    get expirationDate(): number | undefined;
+    /**
+     * The domain of the cookie; this will be normalized with a preceding dot so that
+     * it's also valid for subdomains.
+     */
+    set domain(domain: string | undefined);
+    get domain(): string | undefined;
+    set samesite(value: CookieSameSiteType | undefined);
+    set httponly(value: boolean | undefined);
+    set hostonly(value: boolean | undefined);
+    set ['max-age'](value: number | undefined);
+    set expires(value: string | number | Date | undefined);
+    static fromLegacy(old: LegacyARCCookie): HttpCookie;
+    static fromValue(name: string, value?: string): HttpCookie;
+    constructor(input?: string | IHttpCookie);
+    new(init: IHttpCookie): void;
+    /**
+     * Sets value for `expirationDate` property.
+     * @param expires The value as string, date, or a number
+     */
+    setExpirationTime(expires: Date | string | number | undefined): void;
+    /**
+     * @return Cookie's `name=value` string.
+     */
+    toString(): string;
+    toJSON(): IHttpCookie;
+    /**
+     * Returns a Cookie as a HTTP header string.
+     * @return Cookie string as a HTTP header value
+     */
+    toHeader(): string;
+}

package/build/esm/src/models/HttpCookie.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"HttpCookie.js","sourceRoot":"","sources":["../../../../src/models/HttpCookie.ts"],"names":[],"mappings":"AAIA,4CAA4C;AAC5C,MAAM,kBAAkB,GAAG,uCAAuC,CAAC;AA6FnE,MAAM,OAAO,UAAU;IACrB;;OAEG;IACH,IAAI,GAAG,EAAE,CAAC;IACV;;OAEG;IACH,KAAK,GAAG,EAAE,CAAC;IACX;;;OAGG;IACH,QAAQ,CAAW;IACnB;;OAEG;IACH,IAAI,CAAU;IACd;;OAEG;IACH,MAAM,CAAW;IACjB;;OAEG;IACH,QAAQ,CAAW;IACnB;;;OAGG;IACH,OAAO,GAAa,IAAI,CAAC;IACzB;;;OAGG;IACH,QAAQ,GAAuB,aAAa,CAAC;IAEnC,OAAO,CAAU;IACjB,OAAO,CAAU;IACjB,eAAe,CAAsB;IAE/C;;OAEG;IACH,IAAI,MAAM,CAAC,GAAuB;QAChC,MAAM,QAAQ,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;QAC7B,IAAI,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE;YAC1B,OAAO;SACR;QAED,IAAI,CAAC,OAAO,GAAG,QAAQ,CAAC;QACxB,IAAI,QAAQ,IAAI,CAAC,EAAE;YACjB,kDAAkD;YAClD,wDAAwD;YACxD,IAAI,CAAC,eAAe,GAAG,CAAC,gBAAgB,CAAC;SAC1C;aAAM;YACL,IAAI,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YACrB,GAAG,IAAI,QAAQ,GAAG,IAAI,CAAC;YACvB,IAAI,CAAC,eAAe,GAAG,GAAG,CAAC;SAC5B;QACD,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;IACvB,CAAC;IAED;;OAEG;IACH,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED;;;OAGG;IACH,IAAI,cAAc,CAAC,OAA2C;QAC5D,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;IAClC,CAAC;IAED,IAAI,cAAc;QAChB,OAAO,IAAI,CAAC,eAAe,CAAC;IAC9B,CAAC;IAED;;;OAGG;IACH,IAAI,MAAM,CAAC,MAA0B;QACnC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,MAAM,EAAE;YACX,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;SACvB;aAAM;YACL,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;SACtB;IACH,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,mDAAmD;IACnD,0BAA0B;IAC1B,IAAI;IAEJ,IAAI,QAAQ,CAAC,KAAqC;QAChD,IAAI,CAAC,QAAQ,GAAG,KAAK,IAAI,aAAa,CAAC;IACzC,CAAC;IAED,wCAAwC;IACxC,0BAA0B;IAC1B,IAAI;IAEJ,IAAI,QAAQ,CAAC,KAA0B;QACrC,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;IACxB,CAAC;IAED,wCAAwC;IACxC,0BAA0B;IAC1B,IAAI;IAEJ,IAAI,QAAQ,CAAC,KAA0B;QACrC,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;IACxB,CAAC;IAED,0CAA0C;IAC1C,wBAAwB;IACxB,IAAI;IAEJ,IAAI,CAAC,SAAS,CAAC,CAAC,KAAyB;QACvC,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IACtB,CAAC;IAED,IAAI,OAAO,CAAC,KAAyC;QACnD,IAAI,CAAC,cAAc,GAAG,KAAK,CAAC;IAC9B,CAAC;IAED,MAAM,CAAC,UAAU,CAAC,GAAoB;QACpC,MAAM,IAAI,GAAgB;YACxB,IAAI,EAAE,GAAG,CAAC,IAAI;YACd,KAAK,EAAE,GAAG,CAAC,KAAK,IAAI,EAAE;YACtB,QAAQ,EAAE,aAAa;SACxB,CAAC;QACF,IAAI,GAAG,CAAC,MAAM,EAAE;YACd,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC;SAC1B;QACD,IAAI,OAAO,GAAG,CAAC,OAAO,KAAK,QAAQ,EAAE;YACnC,IAAI,CAAC,cAAc,GAAG,GAAG,CAAC,OAAO,CAAC;SACnC;QACD,IAAI,OAAO,GAAG,CAAC,QAAQ,KAAK,SAAS,EAAE;YACrC,IAAI,CAAC,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC;SAC9B;QACD,IAAI,OAAO,GAAG,CAAC,QAAQ,KAAK,SAAS,EAAE;YACrC,IAAI,CAAC,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC;SAC9B;QACD,IAAI,OAAO,GAAG,CAAC,IAAI,KAAK,QAAQ,EAAE;YAChC,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC;SACtB;QACD,IAAI,OAAO,GAAG,CAAC,MAAM,KAAK,SAAS,EAAE;YACnC,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC;SAC1B;QACD,IAAI,OAAO,GAAG,CAAC,OAAO,KAAK,SAAS,EAAE;YACpC,IAAI,CAAC,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC;SAC5B;QACD,OAAO,IAAI,UAAU,CAAC,IAAI,CAAC,CAAC;IAC9B,CAAC;IAED,MAAM,CAAC,SAAS,CAAC,IAAY,EAAE,KAAK,GAAG,EAAE;QACvC,MAAM,IAAI,GAAgB;YACxB,IAAI;YACJ,KAAK;YACL,QAAQ,EAAE,aAAa;SACxB,CAAC;QACF,OAAO,IAAI,UAAU,CAAC,IAAI,CAAC,CAAC;IAC9B,CAAC;IAED,YAAY,KAA0B;QACpC,IAAI,IAAiB,CAAC;QACtB,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC7B,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;SAC1B;aAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YACpC,IAAI,GAAG,KAAK,CAAC;SACd;aAAM;YACL,IAAI,GAAG;gBACL,IAAI,EAAE,EAAE;gBACR,KAAK,EAAE,EAAE;gBACT,QAAQ,EAAE,aAAa;aACxB,CAAC;SACH;QACD,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACjB,CAAC;IAED,GAAG,CAAC,IAAiB;QACnB,MAAM,EACJ,IAAI,GAAG,EAAE,EACT,KAAK,GAAG,EAAE,EACV,QAAQ,GAAG,aAAa,EACxB,MAAM,EAAE,cAAc,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAClE,GAAG,IAAI,CAAC;QACT,IAAI,IAAI,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;YAC1C,MAAM,IAAI,SAAS,CAAC,4BAA4B,CAAC,CAAC;SACnD;QACD,IAAI,KAAK,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;YAC5C,MAAM,IAAI,SAAS,CAAC,6BAA6B,CAAC,CAAC;SACpD;QACD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;YAC5B,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;gBAClC,MAAM,IAAI,SAAS,CAAC,0BAA0B,CAAC,CAAC;aACjD;YACD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;SAClB;aAAM;YACL,IAAI,CAAC,IAAI,GAAG,SAAS,CAAC;SACvB;QACD,IAAI,MAAM,EAAE;YACV,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE;gBACpC,MAAM,IAAI,SAAS,CAAC,4BAA4B,CAAC,CAAC;aACnD;YACD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;SACtB;aAAM;YACL,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;SACzB;QACD,IAAI,OAAO,cAAc,KAAK,QAAQ,EAAE;YACtC,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;SACtC;aAAM;YACL,IAAI,CAAC,cAAc,GAAG,SAAS,CAAC;SACjC;QACD,IAAI,OAAO,QAAQ,KAAK,SAAS,EAAE;YACjC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;SAC1B;aAAM;YACL,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC;SAC3B;QACD,IAAI,OAAO,QAAQ,KAAK,SAAS,EAAE;YACjC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;SAC1B;aAAM;YACL,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC;SAC3B;QACD,IAAI,OAAO,MAAM,KAAK,SAAS,EAAE;YAC/B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;SACtB;aAAM;YACL,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;SACzB;QACD,IAAI,OAAO,OAAO,KAAK,SAAS,EAAE;YAChC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;SACxB;aAAM;YACL,IAAI,CAAC,OAAO,GAAG,CAAC,IAAI,CAAC,cAAc,CAAC;SACrC;IACH,CAAC;IAED;;;OAGG;IACH,iBAAiB,CAAC,OAA2C;QAC3D,IAAI,KAAyB,CAAC;QAC9B,MAAM,WAAW,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;QACpC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE;YAC9B,KAAK,GAAG,WAAW,CAAC;SACrB;aAAM,IAAI,OAAO,YAAY,IAAI,EAAE;YAClC,KAAK,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;SAC3B;aAAM,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE;YACtC,MAAM,GAAG,GAAG,IAAI,IAAI,CAAC,OAAO,CAAC,CAAC;YAC9B,IAAI,GAAG,CAAC,QAAQ,EAAE,KAAK,cAAc,EAAE;gBACrC,KAAK,GAAG,CAAC,CAAC;aACX;iBAAM;gBACL,KAAK,GAAG,GAAG,CAAC,OAAO,EAAE,CAAC;aACvB;SACF;aAAM;YACL,KAAK,GAAG,SAAS,CAAC;SACnB;QACD,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC;QAC7B,IAAI,CAAC,OAAO,GAAG,CAAC,KAAK,CAAC;IACxB,CAAC;IAED;;OAEG;IACH,QAAQ;QACN,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;QAC7B,OAAO,GAAG,IAAI,IAAI,KAAK,EAAE,CAAC;IAC5B,CAAC;IAED,MAAM;QACJ,MAAM,MAAM,GAAgB;YAC1B,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,QAAQ,EAAE,IAAI,CAAC,QAAQ;SACxB,CAAC;QACF,IAAI,IAAI,CAAC,MAAM,EAAE;YACf,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;SAC7B;QACD,IAAI,OAAO,IAAI,CAAC,cAAc,KAAK,QAAQ,EAAE;YAC3C,MAAM,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;SAC7C;QACD,IAAI,OAAO,IAAI,CAAC,QAAQ,KAAK,SAAS,EAAE;YACtC,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;SACjC;QACD,IAAI,OAAO,IAAI,CAAC,QAAQ,KAAK,SAAS,EAAE;YACtC,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;SACjC;QACD,IAAI,OAAO,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE;YACpC,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;SAC7B;QACD,IAAI,OAAO,IAAI,CAAC,OAAO,KAAK,SAAS,EAAE;YACrC,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;SAC/B;QACD,IAAI,IAAI,CAAC,IAAI,EAAE;YACb,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;SACzB;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;OAGG;IACH,QAAQ;QACN,IAAI,MAAM,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;QAC7B,IAAI,OAAO,CAAC;QACZ,IAAI,IAAI,CAAC,eAAe,EAAE;YACxB,OAAO,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;YACzC,IAAI,OAAO,CAAC,QAAQ,EAAE,KAAK,cAAc,EAAE;gBACzC,OAAO,GAAG,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC;aACvB;SACF;QACD,IAAI,OAAO,EAAE;YACX,MAAM,IAAI,aAAa,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC;SAChD;QACD,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;QAC1D,IAAI,IAAI,EAAE;YACR,MAAM,IAAI,UAAU,IAAI,EAAE,CAAC;SAC5B;QACD,IAAI,MAAM,EAAE;YACV,MAAM,IAAI,YAAY,MAAM,EAAE,CAAC;SAChC;QACD,IAAI,QAAQ,EAAE;YACZ,MAAM,IAAI,cAAc,QAAQ,EAAE,CAAC;SACpC;QACD,QAAQ,QAAQ,EAAE;YAChB,KAAK,KAAK;gBAAE,MAAM,IAAI,gBAAgB,CAAC;gBAAC,MAAM;YAC9C,KAAK,gBAAgB;gBAAE,MAAM,IAAI,iBAAiB,CAAC;gBAAC,MAAM;YAC1D,KAAK,QAAQ;gBAAE,MAAM,IAAI,mBAAmB,CAAC;gBAAC,MAAM;SACrD;QACD,IAAI,MAAM,IAAI,QAAQ,KAAK,QAAQ,EAAE;YACnC,MAAM,IAAI,UAAU,CAAC;SACtB;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;CACF"}

package/build/esm/src/models/HttpHistory.d.ts

@@ -0,0 +1,142 @@
+import { IRequestLog, RequestLog } from './RequestLog.js';
+export declare const Kind = "Core#HttpHistory";
+export declare const createdSymbol: unique symbol;
+export declare const midnightSymbol: unique symbol;
+/**
+ * An HTTP history log.
+ * It's a definition of a HTTP requests history made in an app.
+ */
+export interface IHttpHistory {
+    kind: typeof Kind;
+    /**
+     * The key of the history entry. The application must
+     * revalidate the local copy of the record as the store may change the key.
+     */
+    key: string;
+    /**
+     * The key of the parent workspace.
+     */
+    space: string;
+    /**
+     * The key of the project the request belongs to.
+     */
+    project: string;
+    /**
+     * The application id that generated the history entry.
+     */
+    app: string;
+    /**
+     * The key of the request that generated the history entry.
+     */
+    request: string;
+    /**
+     * The user id that made that request.
+     * This is only available when the store support multi-user environment.
+     */
+    user?: string;
+    /**
+     * The request log.
+     */
+    log: IRequestLog;
+    /**
+     * The timestamp when this history request has been created.
+     */
+    created: number;
+    /**
+     * A timestamp of the midnight when the object was created
+     */
+    midnight?: number;
+}
+/**
+ * An interface used when adding a history in bulk.
+ * The store creates a history object propagating meta values defined here
+ * onto the history objects.
+ * Because of that, bulk operation can only be performed when the requests are made in similar
+ * context (app, space, project).
+ */
+export interface IHttpHistoryBulkAdd {
+    /**
+     * The key of the parent workspace.
+     */
+    space: string;
+    /**
+     * The key of the project the request belongs to.
+     */
+    project: string;
+    /**
+     * The application id that generated the history entry.
+     */
+    app: string;
+    /**
+     * The key of the request that generated the history entry.
+     */
+    request: string;
+    /**
+     * The list of request logs.
+     */
+    log: IRequestLog[];
+}
+/**
+ * An HTTP history is an object containing an information of a request and response
+ * made by an application.
+ *
+ * Note, history object are not mutable. Can only be created or deleted.
+ */
+export declare class HttpHistory {
+    [createdSymbol]: number;
+    [midnightSymbol]: number;
+    kind: string;
+    /**
+     * The key of the history entry. The application must
+     * revalidate the local copy of the record as the store may change the key.
+     */
+    key: string;
+    /**
+     * The key of the parent workspace.
+     */
+    space: string;
+    /**
+     * The key of the project the request belongs to.
+     */
+    project: string;
+    /**
+     * The application id that generated the history entry.
+     */
+    app: string;
+    /**
+     * The user id that made that request.
+     * This is only available when the store support multi-user environment.
+     */
+    user: string;
+    /**
+     * The key of the request that generated the history entry.
+     */
+    request: string;
+    /**
+     * The execution log of the HTTP request with a response.
+     */
+    log: RequestLog;
+    /**
+     * @param value The timestamp when the request was created.
+     */
+    set created(value: number | undefined);
+    /**
+     * @returns The timestamp when the request was created.
+     */
+    get created(): number;
+    /**
+     * @param value The timestamp of the midnight when the request object was updated
+     */
+    set midnight(value: number | undefined);
+    /**
+     * @returns The timestamp of the midnight when the request object was updated
+     */
+    get midnight(): number;
+    constructor(input?: string | IHttpHistory);
+    new(init: IHttpHistory): void;
+    toJSON(): IHttpHistory;
+    /**
+     * @returns The default value for the midnight when the request was last updated.
+     */
+    defaultMidnight(): number;
+}

package/build/esm/src/models/HttpHistory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"HttpHistory.js","sourceRoot":"","sources":["../../../../src/models/HttpHistory.ts"],"names":[],"mappings":"AAAA,OAAO,EAAe,UAAU,EAAE,IAAI,IAAI,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAElF,MAAM,CAAC,MAAM,IAAI,GAAG,kBAAkB,CAAC;AACvC,MAAM,CAAC,MAAM,aAAa,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC;AAC/C,MAAM,CAAC,MAAM,cAAc,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC;AA8EjD;;;;;GAKG;AACH,MAAM,OAAO,WAAW;IACtB,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;IAEpB,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;IAErB,IAAI,GAAG,IAAI,CAAC;IACZ;;;OAGG;IACH,GAAG,GAAG,EAAE,CAAC;IACT;;OAEG;IACH,KAAK,GAAG,EAAE,CAAC;IACX;;OAEG;IACH,OAAO,GAAG,EAAE,CAAC;IACb;;OAEG;IACH,GAAG,GAAG,EAAE,CAAC;IACT;;;OAGG;IACH,IAAI,GAAG,EAAE,CAAC;IACV;;OAEG;IACH,OAAO,GAAG,EAAE,CAAC;IACb;;OAEG;IACH,GAAG,GAAe,IAAI,UAAU,EAAE,CAAC;IAEnC;;OAEG;IACH,IAAI,OAAO,CAAC,KAAyB;QACnC,IAAI,CAAC,KAAK,EAAE;YACV,IAAI,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;SAClC;aAAM;YACL,IAAI,CAAC,aAAa,CAAC,GAAG,KAAK,CAAC;SAC7B;QACD,MAAM,CAAC,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC;QACxC,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QACvB,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,CAAC;IACrC,CAAC;IAED;;OAEG;IACH,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC;IAC3C,CAAC;IAED;;OAEG;IACH,IAAI,QAAQ,CAAC,KAAyB;QACpC,IAAI,CAAC,KAAK,EAAE;YACV,IAAI,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;SAC/C;aAAM;YACL,IAAI,CAAC,cAAc,CAAC,GAAG,KAAK,CAAC;SAC9B;IACH,CAAC;IAED;;OAEG;IACH,IAAI,QAAQ;QACV,IAAI,IAAI,CAAC,cAAc,CAAC,EAAE;YACxB,OAAO,IAAI,CAAC,cAAc,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,eAAe,EAAE,CAAC;IAChC,CAAC;IAED,YAAY,KAA2B;QACrC,IAAI,IAAkB,CAAC;QACvB,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC7B,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;SAC1B;aAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YACpC,IAAI,GAAG,KAAK,CAAC;SACd;aAAM;YACL,MAAM,GAAG,GAAU,IAAI,CAAC,GAAG,EAAE,CAAC;YAC9B,IAAI,GAAG;gBACL,IAAI,EAAE,IAAI;gBACV,OAAO,EAAE,GAAG;gBACZ,IAAI,EAAE,EAAE;gBACR,GAAG,EAAE,EAAE;gBACP,GAAG,EAAE,EAAE;gBACP,OAAO,EAAE,EAAE;gBACX,OAAO,EAAE,EAAE;gBACX,KAAK,EAAE,EAAE;gBACT,GAAG,EAAE;oBACH,IAAI,EAAE,cAAc;iBACrB;aACF,CAAC;SACH;QACD,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACjB,CAAC;IAED,GAAG,CAAC,IAAkB;QACpB,MAAM,EAAE,GAAG,EAAE,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;QAC9F,IAAI,CAAC,GAAG,GAAG,IAAI,UAAU,CAAC,GAAG,CAAC,CAAC;QAC/B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,GAAG,EAAE;YACP,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;SAChB;aAAM;YACL,IAAI,CAAC,GAAG,GAAG,EAAE,CAAC;SACf;QACD,IAAI,GAAG,EAAE;YACP,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;SAChB;aAAM;YACL,IAAI,CAAC,GAAG,GAAG,EAAE,CAAC;SACf;QACD,IAAI,QAAQ,EAAE;YACZ,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;SAC1B;QACD,IAAI,KAAK,EAAE;YACT,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;SACpB;aAAM;YACL,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;SACjB;QACD,IAAI,OAAO,EAAE;YACX,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;SACxB;aAAM;YACL,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;SACnB;QACD,IAAI,OAAO,EAAE;YACX,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;SACxB;aAAM;YACL,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;SACnB;QACD,IAAI,IAAI,EAAE;YACR,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;SAClB;aAAM;YACL,IAAI,CAAC,IAAI,GAAG,EAAE,CAAC;SAChB;IACH,CAAC;IAED,MAAM;QACJ,MAAM,MAAM,GAAiB;YAC3B,IAAI,EAAE,IAAI;YACV,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE;YACtB,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,GAAG,EAAE,IAAI,CAAC,GAAG;YACb,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,GAAG,EAAE,IAAI,CAAC,GAAG;SACd,CAAC;QACF,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;OAEG;IACH,eAAe;QACb,MAAM,CAAC,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACjC,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QACvB,OAAO,CAAC,CAAC,OAAO,EAAE,CAAC;IACrB,CAAC;CACF"}