@omerlo/omerlo-webkit 0.0.17 → 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/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

@@ -35,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),
@@ -53,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)
         };
     }
@@ -76,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/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/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,6 +14,7 @@ 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: Those ones are for retro compatibility with publisher public api v2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@omerlo/omerlo-webkit",
-  "version": "0.0.17",
+  "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": {