@omerlo/omerlo-webkit 0.0.16 → 0.0.19

package/README.md

@@ -1,13 +1,13 @@
 # Omerlo WebKit
 
-This webkit is a wapper arround Omerlo's API to create quickly a website using Omerlo.
+This webkit is a wrapper around Omerlo's API to create quickly a website using Omerlo solutions.
 
-The user's session and tokens will be managed by Omerlo Webkit. The connection state is dispatched
+User's session and tokens will be managed by Omerlo Webkit. The connection state is dispatched
 over all window's tab, no need to refresh other tabs.
 
 ## Using the omerlo webkit
 
-Install the package `omerlo-webkit`
+Install `omerlo-webkit` package
 
 ```sh
 npm i @omerlo/omerlo-webkit

package/dist/omerlo/index.d.ts

@@ -38,6 +38,4 @@ export declare const useReader: (f: typeof fetch) => {
     registerDevice: (params: import("./reader").DeviceParams) => Promise<import("./reader/utils/api").ApiResponse<unknown>>;
     userInfo: () => Promise<import("./reader/utils/api").ApiResponse<import("./reader").UserInfo>>;
     userEntitlements: () => Promise<import("./reader/utils/api").ApiResponse<import("./reader").UserEntitlement[]>>;
-    verifyAccount: (params: import("./reader").VerifyAccountParams) => void;
-    validateAccount: (params: import("./reader").ValidateAccountParams) => void;
 };

package/dist/omerlo/reader/endpoints/accounts.d.ts

@@ -1,18 +1,7 @@
 export declare const accountsFetchers: (f: typeof fetch) => {
     userInfo: () => Promise<import("../utils/api").ApiResponse<UserInfo>>;
     userEntitlements: () => Promise<import("../utils/api").ApiResponse<UserEntitlement[]>>;
-    verifyAccount: (params: VerifyAccountParams) => void;
-    validateAccount: (params: ValidateAccountParams) => void;
 };
-export interface ValidateAccountParams {
-    email: string;
-    callbackUrl: string;
-}
-export declare function validateAccount(f: typeof fetch): (params: ValidateAccountParams) => void;
-export interface VerifyAccountParams {
-    verification_token: string;
-}
-export declare function verifyAccount(f: typeof fetch): (params: VerifyAccountParams) => void;
 export declare function getUserInfo(f: typeof fetch): () => Promise<import("../utils/api").ApiResponse<UserInfo>>;
 export interface UserInfo {
     name: string;

package/dist/omerlo/reader/endpoints/accounts.js

@@ -3,31 +3,10 @@ import { request } from '../utils/request';
 export const accountsFetchers = (f) => {
     return {
         userInfo: getUserInfo(f),
-        userEntitlements: getUserEntitlements(f),
-        verifyAccount: verifyAccount(f),
-        validateAccount: validateAccount(f)
+        userEntitlements: getUserEntitlements(f)
     };
 };
 //
-// Validate an account using the bearer token.
-//
-export function validateAccount(f) {
-    return (params) => {
-        const queryParams = { email: params.email, callback_url: params.callbackUrl };
-        const opts = { queryParams, method: 'post' };
-        request(f, '/account/validate', opts);
-    };
-}
-//
-// Verify an account using the signed JWT token generate on account validation.
-//
-export function verifyAccount(f) {
-    return (params) => {
-        const opts = { queryParams: params };
-        request(f, '/account/verify', opts);
-    };
-}
-//
 // Get user's informations associated to the bearer token.
 //
 export function getUserInfo(f) {

package/dist/omerlo/reader/endpoints/contents.d.ts

@@ -5,6 +5,7 @@ import { type ApiAssocs, type ApiData, type PagingParams } from '../utils/api';
 import { type LocalesMetadata } from '../utils/response';
 import type { PersonSummary } from './person';
 import type { OrganizationSummary } from './organizations';
+export type AuthorSummary = PersonSummary | OrganizationSummary;
 export declare const contentsFetchers: (f: typeof fetch) => {
     getContent: (id: string) => Promise<import("../utils/api").ApiResponse<Content>>;
     listContents: (params?: Partial<PagingParams>) => Promise<import("../utils/api").ApiResponse<ContentSummary[]>>;
@@ -34,7 +35,7 @@ export interface ContentSummary {
     meta: {
         locales: LocalesMetadata;
     };
-    authors: (PersonSummary | OrganizationSummary)[];
+    authors: AuthorSummary[];
 }
 export interface Content extends ContentSummary {
     seo: ContentSeo;

package/dist/omerlo/reader/endpoints/contents.js

@@ -22,6 +22,8 @@ export function getContent(f) {
     return async (id) => {
         const opts = { parser: parseContent };
         return requestPublisher(f, `media/contents/${id}`, opts);
+        // TODO: switch to Reader API (this API is already completed and documented)
+        // return request(f, `/contents/${id}`, opts)
     };
 }
 export function listContents(f) {
@@ -33,6 +35,10 @@ export function listContents(f) {
 export function parseContentSummary(data, assocs) {
     if (data.localized) {
         // NOTE: This is to support publisher public api v2
+        const metadata = (data.metadata ?? []).reduce((acc, { key, value }) => {
+            acc[key] = value;
+            return acc;
+        }, {});
         return {
             id: data.id,
             template: getAssoc(assocs, 'templates', data.template_id),
@@ -51,7 +57,7 @@ export function parseContentSummary(data, assocs) {
             subtitleText: data.localized.subtitle_text,
             visual: parseVisual(data.localized.visual, assocs),
             meta: buildMeta(data.localized.locale),
-            metadata: {},
+            metadata: metadata,
             authors: getAssocs(assocs, 'profiles', data.localized.author_ids)
         };
     }
@@ -74,7 +80,7 @@ export function parseContentSummary(data, assocs) {
             subtitleText: data.subtitle_text,
             visual: parseVisual(data.visual, assocs),
             meta: { locales: parseLocalesMetadata(data.meta) },
-            metadata: {},
+            metadata: data.metadata,
             authors: getAssocs(assocs, 'profiles', data.author_ids)
         };
     }

package/dist/omerlo/reader/endpoints/distributions.d.ts

@@ -1,12 +1,12 @@
 import { type ApiAssocs, type ApiData, type PagingParams } from '../utils/api';
-import type { Issue } from './magazines';
+import type { IssueSummary } from './magazines';
 export declare const distributionFetchers: (f: typeof fetch) => {
     listReleases: (distributionId: string, params?: Partial<PagingParams>) => Promise<import("../utils/api").ApiResponse<Release[]>>;
 };
 export declare function releasesFetcher(f: typeof fetch): (distributionId: string, params?: Partial<PagingParams>) => Promise<import("../utils/api").ApiResponse<Release[]>>;
 export interface Release {
     id: string;
-    issue: Issue;
+    issue: IssueSummary;
     startsAt: Date;
     endsAt: Date | null;
     updatedAt: Date;

package/dist/omerlo/reader/endpoints/events.js

@@ -13,7 +13,8 @@ export function parseEventSummary(data, assocs) {
         kind: 'event',
         type: data.type,
         isAllDay: data.is_all_day,
-        profileImageURL: data.logo_image_url,
+        // NOTE remove logo_image_url once using reader api
+        profileImageURL: data.logo_image_url || data.profile_image_url,
         coverImageURL: data.cover_image_url,
         subscriptionURL: data.subscription_url,
         name,

package/dist/omerlo/reader/endpoints/magazines.d.ts

@@ -35,6 +35,9 @@ export interface IssueSummary {
     color: string | null;
     pdfUrl: string | null;
     visual: Visual | null;
+    metadata: {
+        [key: string]: string;
+    };
     meta: {
         locales: LocalesMetadata;
     };
@@ -44,9 +47,6 @@ export interface Issue extends IssueSummary {
     advertisingKey: string | null;
     descriptionHtml: string | null;
     descriptionText: string | null;
-    metadata: {
-        [key: string]: string;
-    };
     sections: IssueSectionSummary[];
 }
 export interface IssueType {

package/dist/omerlo/reader/endpoints/magazines.js

@@ -48,6 +48,7 @@ export function parseIssueSummary(data, assocs) {
         color: data.color,
         pdfUrl: data.pdf_url,
         visual: parseVisual(data.visual, assocs),
+        metadata: data.metadata,
         meta: {
             locales: parseLocalesMetadata(data.meta)
         },
@@ -60,7 +61,6 @@ export function parseIssue(data, assocs) {
         advertisingKey: data.advertising_key,
         descriptionText: data.description_text,
         descriptionHtml: data.description_html,
-        metadata: data.metadata,
         sections: data.sections.map((section) => parseIssueSectionSummary(section, assocs))
     };
 }

package/dist/omerlo/reader/endpoints/organizations.js

@@ -20,7 +20,8 @@ export function parseOrganizationSummary(data, assocs) {
         profileType: getAssoc(assocs, 'profile_types', data.profile_type_id),
         kind: 'organization',
         name: data.name,
-        profileImageURL: data.logo_image_url,
+        // NOTE remove logo_image_url once using reader api
+        profileImageURL: data.logo_image_url || data.profile_image_url,
         meta: buildMeta(data.localized?.locale),
         summaryHtml: data.localized?.summary_html,
         summaryText: data.localized?.summary_text,

package/dist/omerlo/reader/endpoints/person.js

@@ -11,7 +11,8 @@ export function parsePersonSummary(data, assocs) {
         lastName: data.last_name,
         otherName: data.other_name,
         pronoun: data.pronoun,
-        profileImageURL: data.avatar_image_url,
+        // NOTE remove logo_image_url once using reader api
+        profileImageURL: data.avatar_image_url || data.profile_image_url,
         coverImageURL: data.cover_image_url,
         meta: buildMeta(data.localized?.locale),
         summaryHtml: data.localized?.summary_html,

package/dist/omerlo/reader/endpoints/projects.js

@@ -7,7 +7,8 @@ export function parseProjectSummary(data, assocs) {
         id: data.id,
         profileType: getAssoc(assocs, 'profile_types', data.profile_type_id),
         kind: 'project',
-        profileImageURL: data.logo_image_url,
+        // NOTE remove logo_image_url once using reader api
+        profileImageURL: data.logo_image_url || data.profile_image_url,
         coverImageURL: data.cover_image_url,
         meta: buildMeta(data.localized?.locale),
         name: data.localized?.name,

package/dist/omerlo/reader/fetchers.d.ts

@@ -38,6 +38,4 @@ export declare const fetchers: (f: typeof fetch) => {
     registerDevice: (params: import("./endpoints/device").DeviceParams) => Promise<import("./utils/api").ApiResponse<unknown>>;
     userInfo: () => Promise<import("./utils/api").ApiResponse<import("./endpoints/accounts").UserInfo>>;
     userEntitlements: () => Promise<import("./utils/api").ApiResponse<import("./endpoints/accounts").UserEntitlement[]>>;
-    verifyAccount: (params: import("./endpoints/accounts").VerifyAccountParams) => void;
-    validateAccount: (params: import("./endpoints/accounts").ValidateAccountParams) => void;
 };

package/dist/omerlo/reader/index.js

@@ -4,7 +4,7 @@ import { parseContentBlockTemplate, parseContentTemplate } from './endpoints/con
 import { parseProfileTypeSummary } from './endpoints/profileType';
 import { registerAssocParser } from './utils/assocs';
 import { parseContentSummary } from './endpoints/contents';
-import { parseIssueBlockConfiguration, parseIssueType } from './endpoints/magazines';
+import { parseIssueBlockConfiguration, parseIssueSummary, parseIssueType } from './endpoints/magazines';
 export * from './stores/user_session';
 export function initReader() {
     registerAssocParser('categories', parseCategory);
@@ -14,8 +14,12 @@ export function initReader() {
     registerAssocParser('profile_block_types', parseProfileBlock);
     registerAssocParser('content_block_templates', parseContentBlockTemplate);
     registerAssocParser('contents', parseContentSummary);
+    registerAssocParser('issues', parseIssueSummary);
     registerAssocParser('issue_types', parseIssueType);
     registerAssocParser('issue_block_configurations', parseIssueBlockConfiguration);
-    // NOTE: This one is for retro compatibility with publisher public api v2
+    // NOTE: Those ones are for retro compatibility with publisher public api v2
+    // Reason is we renamed some assocs keys in Reader API that are different
+    // from Publisher public API V2
     registerAssocParser('templates', parseContentTemplate);
+    registerAssocParser('block_templates', parseContentBlockTemplate);
 }

package/dist/omerlo/reader/server/index.d.ts

@@ -3,3 +3,4 @@ export declare const handleUserToken: import("@sveltejs/kit").Handle;
 export * from './token';
 export * from './utils';
 export * from './email';
+export * from './oauth';

package/dist/omerlo/reader/server/index.js

@@ -4,3 +4,4 @@ export const handleUserToken = Hooks.handleUserToken;
 export * from './token';
 export * from './utils';
 export * from './email';
+export * from './oauth';

package/dist/omerlo/reader/server/oauth.d.ts

@@ -0,0 +1 @@
+export declare function verifyOauth(email: string, oauthUserId: string): Promise<void>;

package/dist/omerlo/reader/server/oauth.js

@@ -0,0 +1,23 @@
+import { env } from '$env/dynamic/private';
+import { ApiError } from '../utils/api';
+import { getApplicationToken } from './utils';
+export async function verifyOauth(email, oauthUserId) {
+    const url = getOmerloEndpoint();
+    const accessToken = await getApplicationToken();
+    const headers = new Headers({
+        'x-omerlo-media-id': env.PRIVATE_OMERLO_MEDIA_ID,
+        Authorization: `Bearer ${accessToken}`
+    });
+    url.pathname = '/api/media/v1/oauth/verify';
+    url.searchParams.append('oauth_user_id', oauthUserId);
+    url.searchParams.append('email', email);
+    const resp = await fetch(url, { method: 'POST', headers });
+    if (resp.ok) {
+        return;
+    }
+    const payload = await resp.json();
+    throw new ApiError(resp.status, payload.error, resp.statusText);
+}
+function getOmerloEndpoint() {
+    return new URL(`${env.PRIVATE_OMERLO_PROTOCOL}://${env.PRIVATE_OMERLO_HOST}`);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@omerlo/omerlo-webkit",
-  "version": "0.0.16",
+  "version": "0.0.19",
   "scripts": {
     "dev": "vite dev",
     "build": "vite build && npm run package",
@@ -64,7 +64,7 @@
     "typescript-eslint": "^8.0.0",
     "vite": "^5.0.11"
   },
-  "description": "This webkit is a wapper arround Omerlo's API to create quickly a website using Omerlo.",
+  "description": "Omerlo's API wrapper to help developing blazing fast website.",
   "main": "eslint.config.js",
   "directories": {},
   "repository": {