@lokalise/harmony 1.17.0-exp-jwtheaderfactorysharedauth.1 → 1.17.0

package/dist/types/src/features/auth/core/headers/createHeaderBuilderMiddleware.d.ts

@@ -0,0 +1,32 @@
+import { HeaderBuilder, Headers } from './headerBuilder';
+/**
+ * A helper function that creates a HeaderBuilderMiddleware, it removed the
+ * complexity of creating a new instance of the middleware class and tracking the input types.
+ *
+ * @param middleware - A function that modifies a HeaderBuilder
+ * @returns - A new instance of HeaderBuilderMiddleware to be used with a HeaderBuilder
+ */
+export declare function createHeaderBuilderMiddleware<const H extends Headers>(middleware: (builder: HeaderBuilder) => HeaderBuilder<H> | Promise<HeaderBuilder<H>>): HeaderBuilderMiddleware<H>;
+export type { HeaderBuilderMiddleware };
+/**
+ * A middleware class that allows you to modify a HeaderBuilder in a type-safe way.
+ * It receives a builder and returns a new builder with the modifications applied.
+ *
+ * @example
+ * ```typescript
+ * const authMiddleware = createHeaderBuilderMiddleware(async (builder) => {
+ *   const token = await fetchToken()
+ *   return builder.add('Authorization', `Bearer ${token}`)
+ * })
+ *
+ *  const builder = HeaderBuilder.create()
+ *  .with(authMiddleware)
+ *
+ *  const headers = await builder.resolve() // Type of headers is { 'Authorization': string }
+ *  console.log(headers) // { 'Authorization': 'Bearer <token>' }
+ */
+declare class HeaderBuilderMiddleware<const H extends Headers> {
+    private readonly middleware;
+    constructor(middleware: (builder: HeaderBuilder<Headers>) => HeaderBuilder<H> | Promise<HeaderBuilder<H>>);
+    apply<const BH extends Headers>(base: HeaderBuilder<BH>): HeaderBuilder<BH & H>;
+}

package/dist/types/src/features/auth/core/headers/createHeaderBuilderMiddleware.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/src/features/auth/core/headers/headerBuilder.d.ts

@@ -1,4 +1,6 @@
-export type Headers<K extends string = string, V = any> = Record<K, V>;
+import { HeaderBuilderMiddleware } from './createHeaderBuilderMiddleware';
+export type Headers<K extends string = string, V extends string = string> = Record<K, V>;
+type NoHeaders = {};
 /**
  * A builder class that helps to build up a set of headers in a type-safe way.
  * It allows you to add headers, merge them together, and resolve them into a single object.
@@ -26,7 +28,7 @@ export type Headers<K extends string = string, V = any> = Record<K, V>;
  * //    'Authorization': 'Bearer <token>'
  * // }
  */
-export declare class HeaderBuilder<H extends Headers = {}> {
+export declare class HeaderBuilder<H extends Headers = NoHeaders> {
     private readonly factories;
     /**
      * Creates a new HeaderBuilder, optionally with an initial set of headers.
@@ -92,7 +94,7 @@ export declare class HeaderBuilder<H extends Headers = {}> {
      *
      * @param extension - An object with the headers to add
      */
-    and<const K extends string, const V, E extends Headers<K, V>>(extension: E | Promise<E>): HeaderBuilder<H & E>;
+    and<const K extends string, const V extends string, E extends Headers<K, V>>(extension: E | Promise<E>): HeaderBuilder<H & E>;
     /**
      * Adds a factory function that returns a promise of headers to the builder.
      * This is useful when you need to fetch some data asynchronously to build the headers.
@@ -166,34 +168,4 @@ export declare class HeaderBuilder<H extends Headers = {}> {
      */
     resolve(): Promise<H>;
 }
-/**
- * A middleware class that allows you to modify a HeaderBuilder in a type-safe way.
- * It receives a builder and returns a new builder with the modifications applied.
- *
- * @example
- * ```typescript
- * const authMiddleware = createHeaderBuilderMiddleware(async (builder) => {
- *   const token = await fetchToken()
- *   return builder.add('Authorization', `Bearer ${token}`)
- * })
- *
- *  const builder = HeaderBuilder.create()
- *  .with(authMiddleware)
- *
- *  const headers = await builder.resolve() // Type of headers is { 'Authorization': string }
- *  console.log(headers) // { 'Authorization': 'Bearer <token>' }
- */
-declare class HeaderBuilderMiddleware<const H extends Headers> {
-    private readonly middleware;
-    constructor(middleware: (builder: HeaderBuilder<Headers>) => HeaderBuilder<H> | Promise<HeaderBuilder<H>>);
-    apply<const BH extends Headers>(base: HeaderBuilder<BH>): HeaderBuilder<BH & H>;
-}
-/**
- * A helper function that creates a HeaderBuilderMiddleware, it removed the
- * complexity of creating a new instance of the middleware class and tracking the input types.
- *
- * @param middleware - A function that modifies a HeaderBuilder
- * @returns - A new instance of HeaderBuilderMiddleware to be used with a HeaderBuilder
- */
-export declare function createHeaderBuilderMiddleware<const H extends Headers>(middleware: (builder: HeaderBuilder) => HeaderBuilder<H> | Promise<HeaderBuilder<H>>): HeaderBuilderMiddleware<H>;
-export type { HeaderBuilderMiddleware };
+export {};

package/dist/types/src/features/auth/core/middleware/jwtAuthHeaderBuilderMiddleware.d.ts

@@ -5,6 +5,6 @@ export type JwtAuthHeaderBuilderMiddlewareProps = {
     generateNewToken?: () => Promise<JwtToken | null>;
     onNewTokenIssued?: (token: JwtToken) => void;
 };
-export declare function JwtAuthHeaderBuilderMiddleware(props: JwtAuthHeaderBuilderMiddlewareProps): import('../headers/headerBuilder').HeaderBuilderMiddleware<{
+export declare function JwtAuthHeaderBuilderMiddleware(props: JwtAuthHeaderBuilderMiddlewareProps): import('../headers/createHeaderBuilderMiddleware').HeaderBuilderMiddleware<{
     Authorization: `Bearer ${string}`;
 }>;

package/dist/types/src/features/auth/core/middleware/publicApiHeaderBuilderMiddleware.d.ts

@@ -1,3 +1,3 @@
-export declare const PublicApiHeaderBuilderMiddleware: import('../headers/headerBuilder').HeaderBuilderMiddleware<{
-    'x-lokalise-plugin': string;
+export declare const PublicApiHeaderBuilderMiddleware: import('../headers/createHeaderBuilderMiddleware').HeaderBuilderMiddleware<{
+    'x-lokalise-plugin': "true";
 }>;

package/dist/types/src/features/auth/node.d.ts

@@ -3,7 +3,7 @@ export { PublicApiHeaderBuilderMiddleware } from './core/middleware/publicApiHea
 export type { JwtTokenPayload } from './core/types/jwtTokenPayload';
 export { parseJwtTokenPayload } from './core/utils/jwtTokenPayload';
 export { getJwtTokenFromCookie, getCsrfTokenFromCookie } from './frontend/utils/cookieTokenUtils';
-export { HeaderBuilder, createHeaderBuilderMiddleware, type HeaderBuilderMiddleware, type Headers, } from './core/headers/headerBuilder';
+export { HeaderBuilder, type Headers, } from './core/headers/headerBuilder';
 export * from './backend/services/getAuthenticatedSessionDetailFromRequest';
 export * from './frontend/services/generateTokenFromClassicSession';
 export * from './frontend/services/refreshExpiredToken';
@@ -11,3 +11,4 @@ export * from './frontend/hooks/useGetPromotedClassicSessionJwtQuery';
 export * from './frontend/hooks/useAuthenticatedSessionPayload';
 export * from './frontend/hooks/useAuthenticatedUser';
 export * from './frontend/hooks/useAuthenticatedProjectContributor';
+export { createHeaderBuilderMiddleware, type HeaderBuilderMiddleware, } from './core/headers/createHeaderBuilderMiddleware';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@lokalise/harmony",
-    "version": "1.17.0-exp-jwtheaderfactorysharedauth.1",
+    "version": "1.17.0",
     "author": {
         "name": "Lokalise",
         "url": "https://lokalise.com/"