Cookie store and bring back cookie service

Author: tolyo

@types/core/di/ng-module/ng-module.d.ts

@@ -183,6 +183,12 @@ export class NgModule {
    * @returns {NgModule}
    */
   local(name: string, ctor: Function): NgModule;
+  /**
+   * @param {string} name
+   * @param {Function} ctor
+   * @returns {NgModule}
+   */
+  cookie(name: string, ctor: Function): NgModule;
   /**
    * @param {string} name
    * @param {Function} ctor

@types/namespace.d.ts

@@ -66,6 +66,11 @@ import { Location as TLocationService } from "./services/location/location.js";
 import { AnimateService as TAnimateService } from "./animations/interface.ts";
 import { StorageBackend as TStorageBackend } from "./services/storage/interface.ts";
 import { StreamConnectionConfig as TStreamConnectionConfig } from "./services/stream/interface.ts";
+import { CookieService as TCookieService } from "./services/cookie/cookie.js";
+import {
+  CookieStoreOptions as TCookieStoreOptions,
+  CookieOptions as TCookieOptions,
+} from "./services/cookie/interface.ts";
 declare global {
   interface Function {
     $inject?: readonly string[] | undefined;
@@ -100,6 +105,7 @@ declare global {
     type AnimateService = TAnimateService;
     type CompileService = TCompileFn;
     type ControllerService = TControllerService;
+    type CookieService = TCookieService;
     type ExceptionHandlerService = TErrorHandler;
     type FilterService = TFilterFactory;
     type HttpParamSerializerSerService = THttpParamSerializer;
@@ -132,5 +138,7 @@ declare global {
     > = TInjectable<T>;
     type StorageBackend = TStorageBackend;
     type StreamConnectionConfig = TStreamConnectionConfig;
+    type CookieOptions = TCookieOptions;
+    type CookieStoreOptions = TCookieStoreOptions;
   }
 }

@types/services/cookie/cookie.d.ts

@@ -0,0 +1,66 @@
+/**
+ * $cookies service class
+ *
+ * Provides high-level APIs for interacting with browser cookies:
+ *  - Raw get/set/remove
+ *  - JSON serialization helpers
+ *  - Global defaults supplied by $cookiesProvider
+ */
+export class CookieService {
+  /**
+   * @param {ng.CookieOptions} defaults
+   *   Default cookie attributes defined by `$cookiesProvider.defaults`.
+   */
+  constructor(defaults: ng.CookieOptions);
+  /** @type {CookieOptions} */
+  defaults: CookieOptions;
+  /**
+   * Retrieves a raw cookie value.
+   *
+   * @param {string} key
+   * @returns {string|null}
+   */
+  get(key: string): string | null;
+  /**
+   * Retrieves a cookie and deserializes its JSON content.
+   *
+   * @template T
+   * @param {string} key
+   * @returns {T|null}
+   */
+  getObject<T>(key: string): T | null;
+  /**
+   * Returns an object containing all raw cookies.
+   *
+   * @returns {Record<string, string>}
+   */
+  getAll(): Record<string, string>;
+  /**
+   * Sets a raw cookie value.
+   *
+   * @param {string} key
+   * @param {string} value
+   * @param {CookieOptions} [options]
+   */
+  put(key: string, value: string, options?: CookieOptions): void;
+  /**
+   * Serializes an object as JSON and stores it as a cookie.
+   *
+   * @param {string} key
+   * @param {any} value
+   * @param {CookieOptions} [options]
+   */
+  putObject(key: string, value: any, options?: CookieOptions): void;
+  /**
+   * Removes a cookie by setting an expired date.
+   *
+   * @param {string} key
+   * @param {CookieOptions} [options]
+   */
+  remove(key: string, options?: CookieOptions): void;
+}
+export class CookieProvider {
+  defaults: {};
+  $get(): CookieService;
+}
+export type CookieOptions = import("./interface.ts").CookieOptions;

@types/services/cookie/interface.d.ts

@@ -0,0 +1,12 @@
+export interface CookieOptions {
+  path?: string;
+  domain?: string;
+  expires?: Date | string | number;
+  secure?: boolean;
+  samesite?: "Lax" | "Strict" | "None";
+}
+export interface CookieStoreOptions {
+  serialize?: (value: any) => string;
+  deserialize?: (text: string) => any;
+  cookie?: CookieOptions;
+}

docs/layouts/partials/hooks/head-end.html

@@ -1,3 +1 @@
-
-      <script src="https://cdn.jsdelivr.net/npm/@angular-wave/[email protected]/dist/angular-ts.umd.js"></script>
-    
+<script src="https://cdn.jsdelivr.net/npm/@angular-wave/[email protected]/dist/angular-ts.umd.js"></script>

src/core/di/injector.js

@@ -12,6 +12,7 @@ import {
 import { INJECTOR_LITERAL } from "./ng-module/ng-module.js";
 import { InjectorService, ProviderInjector } from "./internal-injector.js";
 import { createPersistentProxy } from "../../services/storage/storage.js";
+import { $injectTokens } from "../../injection-tokens";
 
 const $injectorMinErr = minErr(INJECTOR_LITERAL);
 const providerSuffix = "Provider";
@@ -38,6 +39,7 @@ export function createInjector(modulesToLoad, strictDi = false) {
       session: supportObject(session),
       local: supportObject(local),
       store: supportObject(store),
+      cookie: supportObject(cookie),
       decorator,
     },
   };
@@ -195,6 +197,46 @@ export function createInjector(modulesToLoad, strictDi = false) {
     });
   }
 
+  /**
+   * Registers a cookie-persistent service.
+   *
+   * @param {string} name
+   * @param {Function} ctor
+   * @param {ng.CookieStoreOptions} [options]
+   */
+  function cookie(name, ctor, options = {}) {
+    return provider(name, {
+      $get: [
+        $injectTokens.$injector,
+        ($injector) => {
+          const instance = $injector.instantiate(ctor);
+          const $cookie = $injector.get($injectTokens.$cookie);
+          const serialize = options.serialize ?? JSON.stringify;
+          const deserialize = options.deserialize ?? JSON.parse;
+          const cookieOpts = options.cookie ?? {};
+
+          return createPersistentProxy(instance, name, {
+            getItem: (key) => {
+              const raw = $cookie.get(key);
+              return raw == null ? null : raw;
+            },
+
+            setItem: (key, value) => {
+              $cookie.put(key, value, cookieOpts);
+            },
+
+            removeItem: (key) => {
+              $cookie.remove(key, cookieOpts);
+            },
+
+            serialize,
+            deserialize,
+          });
+        },
+      ],
+    });
+  }
+
   /**
    * Registers a service persisted in a custom storage
    *

src/core/di/ng-module/ng-module.js

@@ -327,6 +327,19 @@ export class NgModule {
     return this;
   }
 
+  /**
+   * @param {string} name
+   * @param {Function} ctor
+   * @returns {NgModule}
+   */
+  cookie(name, ctor) {
+    if (ctor && isFunction(ctor)) {
+      ctor["$$moduleName"] = name;
+    }
+    this.invokeQueue.push([$t.$provide, "cookie", [name, ctor]]);
+    return this;
+  }
+
   /**
    * @param {string} name
    * @param {Function} ctor

src/injection-tokens.js

@@ -32,6 +32,7 @@ export const $injectTokens = Object.freeze({
   $animateCss: "$animateCss",
   $aria: "$aria",
   $compile: "$compile",
+  $cookie: "$cookie",
   $controller: "$controller",
   $document: "$document",
   $eventBus: "$eventBus",

src/namespace.ts

@@ -70,6 +70,11 @@ import { Location as TLocationService } from "./services/location/location.js";
 import { AnimateService as TAnimateService } from "./animations/interface.ts";
 import { StorageBackend as TStorageBackend } from "./services/storage/interface.ts";
 import { StreamConnectionConfig as TStreamConnectionConfig } from "./services/stream/interface.ts";
+import { CookieService as TCookieService } from "./services/cookie/cookie.js";
+import {
+  CookieStoreOptions as TCookieStoreOptions,
+  CookieOptions as TCookieOptions,
+} from "./services/cookie/interface.ts";
 
 /* ────────────────────────────────────────────────
    Runtime global initialization
@@ -120,6 +125,7 @@ declare global {
     export type AnimateService = TAnimateService;
     export type CompileService = TCompileFn;
     export type ControllerService = TControllerService;
+    export type CookieService = TCookieService;
     export type ExceptionHandlerService = TErrorHandler;
     export type FilterService = TFilterFactory;
     export type HttpParamSerializerSerService = THttpParamSerializer;
@@ -154,5 +160,7 @@ declare global {
     > = TInjectable<T>;
     export type StorageBackend = TStorageBackend;
     export type StreamConnectionConfig = TStreamConnectionConfig;
+    export type CookieOptions = TCookieOptions;
+    export type CookieStoreOptions = TCookieStoreOptions;
   }
 }

src/ng.js

@@ -136,6 +136,7 @@ import { ngViewportDirective } from "./directive/viewport/viewport.js";
 import { ngWorkerDirective } from "./directive/worker/worker.js";
 import { ngWasmDirective } from "./directive/wasm/wasm.js";
 import { ngScopeDirective } from "./directive/scope/scope.js";
+import { CookieProvider } from "./services/cookie/cookie.js";
 
 /**
  * Initializes core `ng` module.
@@ -260,6 +261,7 @@ export function registerNgModule(angular) {
             $$animateCache: AnimateCacheProvider,
             $$animateQueue: AnimateQueueProvider,
             $controller: ControllerProvider,
+            $cookie: CookieProvider,
             $exceptionHandler: ExceptionHandlerProvider,
             $filter: FilterProvider,
             $interpolate: InterpolateProvider,