@operato/p13n 8.0.0-beta.0 → 8.0.0-beta.1

package/CHANGELOG.md

@@ -3,6 +3,15 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [8.0.0-beta.1](https://github.com/hatiolab/operato/compare/v8.0.0-beta.0...v8.0.0-beta.1) (2025-01-08)
+
+
+### :bug: Bug Fix
+
+* missing .npmignore ([be05985](https://github.com/hatiolab/operato/commit/be05985abfae4af53501f718dd52932099f7fbcb))
+
+
+
 ## [8.0.0-beta.0](https://github.com/hatiolab/operato/compare/v8.0.0-alpha.56...v8.0.0-beta.0) (2025-01-07)
 
 **Note:** Version bump only for package @operato/p13n

package/package.json

@@ -2,7 +2,7 @@
   "name": "@operato/p13n",
   "description": "Webcomponent personalization following open-wc recommendations",
   "author": "heartyoh",
-  "version": "8.0.0-beta.0",
+  "version": "8.0.0-beta.1",
   "main": "dist/src/index.js",
   "module": "dist/src/index.js",
   "license": "MIT",
@@ -51,10 +51,10 @@
   "dependencies": {
     "@lit/context": "^1.1.2",
     "@material/web": "^2.0.0",
-    "@operato/graphql": "^8.0.0-beta.0",
-    "@operato/i18n": "^8.0.0-beta.0",
-    "@operato/shell": "^8.0.0-beta.0",
-    "@operato/utils": "^8.0.0-beta.0",
+    "@operato/graphql": "^8.0.0-beta.1",
+    "@operato/i18n": "^8.0.0-beta.1",
+    "@operato/shell": "^8.0.0-beta.1",
+    "@operato/utils": "^8.0.0-beta.1",
     "lit": "^3.1.2"
   },
   "devDependencies": {
@@ -89,5 +89,5 @@
       "prettier --write"
     ]
   },
-  "gitHead": "c4e9cc245659d050a9ffd66542083a6daad4bcb9"
+  "gitHead": "d5b28a2e9deb632c0dc80132f6a7196dd6fe4220"
 }

package/.editorconfig

@@ -1,29 +0,0 @@
-# EditorConfig helps developers define and maintain consistent
-# coding styles between different editors and IDEs
-# editorconfig.org
-
-root = true
-
-
-[*]
-
-# Change these settings to your own preference
-indent_style = space
-indent_size = 2
-
-# We recommend you to keep these unchanged
-end_of_line = lf
-charset = utf-8
-trim_trailing_whitespace = true
-insert_final_newline = true
-
-[*.md]
-trim_trailing_whitespace = false
-
-[*.json]
-indent_size = 2
-
-[*.{html,js,md}]
-block_comment_start = /**
-block_comment = *
-block_comment_end = */

package/.storybook/main.js

@@ -1,3 +0,0 @@
-module.exports = {
-  stories: ['../dist/stories/**/*.stories.{js,md,mdx}'],
-};

package/.storybook/preview.js

@@ -1,52 +0,0 @@
-import { i18next } from '@operato/i18n'
-
-export const globalTypes = {
-  locale: {
-    name: 'Locale',
-    description: 'Internationalization locale',
-    toolbar: {
-      icon: 'globe',
-      items: [
-        { value: 'en', right: '🇺🇸', title: 'English' },
-        { value: 'ko', right: '🇰🇷', title: '한국어' },
-        { value: 'zh', right: '🇨🇳', title: '中文' },
-        { value: 'ja', right: '🇯🇵', title: '日本語' },
-        { value: 'ms', right: '🇲🇾', title: 'Bahasa Melayu' }
-      ],
-      showName: true
-    }
-  },
-  theme: {
-    name: 'Theme',
-    description: 'Global theme for components',
-    toolbar: {
-      icon: 'paintbrush',
-      items: [
-        { value: 'light', title: 'Light' },
-        { value: 'dark', title: 'Dark' }
-      ],
-      showName: true
-    }
-  }
-}
-
-export const decorators = [
-  (Story, context) => {
-    const { locale, theme } = context.globals
-
-    if (locale) {
-      i18next.changeLanguage(locale)
-    }
-
-    // Set the theme class for the document
-    if (theme === 'dark') {
-      document.documentElement.classList.add('dark')
-      document.documentElement.classList.remove('light')
-    } else {
-      document.documentElement.classList.add('light')
-      document.documentElement.classList.remove('dark')
-    }
-
-    return Story()
-  }
-]

package/.storybook/server.mjs

@@ -1,8 +0,0 @@
-import { storybookPlugin } from '@web/dev-server-storybook';
-import baseConfig from '../web-dev-server.config.mjs';
-
-export default /** @type {import('@web/dev-server').DevServerConfig} */ ({
-  ...baseConfig,
-  open: '/',
-  plugins: [storybookPlugin({ type: 'web-components' }), ...baseConfig.plugins],
-});

package/src/index.ts

@@ -1,5 +0,0 @@
-export * from './types.js'
-export * from './p13n-mixin.js'
-export * from './ox-user-preferences-context.js'
-export * from './ox-user-preferences-provider.js'
-export * from './ox-user-preferences-consumer.js'

package/src/ox-user-preferences-consumer.ts

@@ -1,39 +0,0 @@
-import { LitElement, html } from 'lit'
-import { customElement, property } from 'lit/decorators.js'
-import { consume } from '@lit/context'
-import { OxUserPreferencesContext } from './ox-user-preferences-context'
-
-@customElement('ox-user-preferences-consumer')
-export class OxUserPreferenceConsumer extends LitElement {
-  @property({ type: String }) userPreferenceKey = ''
-  @property({ type: Object }) userPreference: any = null
-
-  @consume({ context: OxUserPreferencesContext, subscribe: true })
-  contextUserPreferences!: Map<string, any>
-
-  async connectedCallback() {
-    super.connectedCallback()
-    this.userPreference = this.contextUserPreferences.get(this.userPreferenceKey)
-  }
-
-  updateUserPreference(newPreference: any) {
-    if (this.contextUserPreferences) {
-      this.contextUserPreferences.set(this.userPreferenceKey, newPreference)
-    }
-    const event = new CustomEvent('user-preference-update', {
-      detail: { key: this.userPreferenceKey, preference: newPreference },
-      bubbles: true,
-      composed: true
-    })
-    this.dispatchEvent(event)
-  }
-
-  render() {
-    return html`
-      <div>
-        ${this.userPreferenceKey}: ${JSON.stringify(this.userPreference?.preference || {})}
-        <button @click="${() => this.updateUserPreference({ someKey: 'newValue' })}">Update</button>
-      </div>
-    `
-  }
-}

package/src/ox-user-preferences-context.ts

@@ -1,3 +0,0 @@
-import { createContext } from '@lit/context'
-
-export const OxUserPreferencesContext = createContext<Map<string, any>>('user-preferences')

package/src/ox-user-preferences-provider.ts

@@ -1,58 +0,0 @@
-import { LitElement, html, css } from 'lit'
-import { customElement, property } from 'lit/decorators.js'
-import { provide } from '@lit/context'
-import { OxUserPreferencesContext } from './ox-user-preferences-context'
-import { UserPreferencesService } from './user-preferences-service'
-
-@customElement('ox-user-preferences-provider')
-export class OxUserPreferencesProvider extends LitElement {
-  static styles = css`
-    :host {
-      display: flex;
-    }
-  `
-
-  @property({ type: Object })
-  @provide({ context: OxUserPreferencesContext })
-  private userPreferences = new Map<string, any>()
-
-  @property({ type: Boolean, attribute: 'load-initial-preferences' }) loadInitialPreferences = false
-
-  private userPreferencesService = new UserPreferencesService()
-
-  connectedCallback() {
-    super.connectedCallback()
-    if (this.loadInitialPreferences) {
-      this.fetchInitialPreferences()
-    }
-  }
-
-  async fetchInitialPreferences() {
-    await this.userPreferencesService.fetchInitialPreferences()
-    this.userPreferences = this.userPreferencesService.userPreferences
-    this.requestUpdate()
-  }
-
-  async getPreference(key: string): Promise<any> {
-    const preference = await this.userPreferencesService.getPreference(key)
-    this.userPreferences = this.userPreferencesService.userPreferences
-
-    this.requestUpdate()
-    return preference
-  }
-
-  async updatePreference(key: string, newPreference: any) {
-    await this.userPreferencesService.updatePreference(key, newPreference)
-    this.userPreferences = this.userPreferencesService.userPreferences
-    this.requestUpdate()
-  }
-
-  handleUserPreferenceUpdate(event: CustomEvent) {
-    const { key, preference } = event.detail
-    this.updatePreference(key, preference)
-  }
-
-  render() {
-    return html` <slot @user-preference-update="${this.handleUserPreferenceUpdate}"></slot> `
-  }
-}

package/src/p13n-mixin.ts

@@ -1,142 +0,0 @@
-import gql from 'graphql-tag'
-import { PageView } from '@operato/shell'
-import { i18next } from '@operato/i18n'
-import { client } from '@operato/graphql'
-import { getPathInfo } from '@operato/utils'
-import { PagePreferenceProvider } from './types'
-
-type Constructor<T> = new (...args: any[]) => T
-interface CustomElement {}
-
-const PagePreferences: {
-  [page: string]: Promise<{
-    __timestamp: number
-    [element: string]: any
-  }>
-} = {}
-
-export const p13n = <T extends Constructor<CustomElement>>(base: T) =>
-  class extends base {
-    __preferenceProviders = {} as { [element: string]: PagePreferenceProvider }
-
-    getPagePreferenceProvider(element: string) {
-      if (!element) {
-        return
-      }
-
-      if (this.__preferenceProviders[element]) {
-        return this.__preferenceProviders[element]
-      }
-
-      if (this instanceof PageView) {
-        var page = (this as PageView).lifecycle.page!
-      } else {
-        const { pathname } = window.location
-        const { path } = getPathInfo(pathname)
-        var page = path?.split('/')[1] || '/'
-      }
-
-      this.__preferenceProviders[element] = {
-        load: async (): Promise<any> => {
-          /* cache를 하루만 유지하도록 함. (모바일은 오랫동안 어플리케이션을 리프레시하지 않을 수 있어서, 캐시를 오랫동안 유지할 수 있으므로) */
-          if (!PagePreferences[page] || (await PagePreferences[page]).__timestamp < Date.now() - 60 * 60 * 24 * 1000) {
-            PagePreferences[page] = new Promise<any>(resolve => {
-              client
-                .query({
-                  query: gql`
-                    query ($page: String!) {
-                      myPageAllPreferences(page: $page) {
-                        element
-                        preference
-                      }
-                    }
-                  `,
-                  variables: {
-                    page
-                  }
-                })
-                .then(response => {
-                  if (!response.errors) {
-                    resolve(
-                      response.data.myPageAllPreferences?.reduce(
-                        (sum: any, pagePreference: { element: string; preference: any }) => {
-                          sum[pagePreference.element] = pagePreference.preference
-                          return sum
-                        },
-                        {
-                          __timestamp: Date.now()
-                        }
-                      )
-                    )
-                  }
-                })
-            })
-          }
-
-          return (await PagePreferences[page])?.[element] || {}
-        },
-
-        save: async (preference: any): Promise<any> => {
-          const response = await client.mutate({
-            mutation: gql`
-              mutation ($page: String!, $element: String!, $preference: Object!) {
-                updateMyPagePreference(page: $page, element: $element, preference: $preference) {
-                  preference
-                }
-              }
-            `,
-            variables: {
-              page,
-              element,
-              preference
-            }
-          })
-
-          if (!response.errors) {
-            document.dispatchEvent(
-              new CustomEvent('notify', {
-                detail: { message: i18next.t('text.updated_successfully'), option: { timer: 3000 } }
-              })
-            )
-
-            if (!PagePreferences[page]) {
-              PagePreferences[page] = new Promise<any>(resolve => resolve({}))
-            }
-
-            const preference = await PagePreferences[page]
-            if (preference) {
-              preference[element] = response.data.updateMyPagePreference.preference
-            }
-
-            return (await PagePreferences[page])?.[element]
-          }
-        },
-
-        reset: async (): Promise<void> => {
-          const response = await client.mutate({
-            mutation: gql`
-              mutation ($page: String!, $element: String!) {
-                deleteMyPagePreference(page: $page, element: $element)
-              }
-            `,
-            variables: {
-              page,
-              element
-            }
-          })
-
-          if (!response.errors) {
-            document.dispatchEvent(
-              new CustomEvent('notify', {
-                detail: { message: i18next.t('text.updated_successfully'), option: { timer: 3000 } }
-              })
-            )
-
-            delete PagePreferences[page] /* cache를 update할 기회를 주기위해서, promise를 clear시킴 */
-          }
-        }
-      }
-
-      return this.__preferenceProviders[element]
-    }
-  }

package/src/types.ts

@@ -1,9 +0,0 @@
-export interface PagePreferenceProvider {
-  page?: string
-  element?: string
-  preference?: any
-
-  load: () => any | Promise<any>
-  save: (preference: any) => any | Promise<any>
-  reset: () => void | Promise<void>
-}

package/src/user-preferences-service.ts

@@ -1,72 +0,0 @@
-import { client } from '@operato/graphql'
-import gql from 'graphql-tag'
-
-const GET_USER_PREFERENCE = gql`
-  query GetUserPreference($key: String!) {
-    myUserPreference(key: $key) {
-      id
-      key
-      preference
-    }
-  }
-`
-
-const GET_INITIAL_PREFERENCES = gql`
-  query GetInitialPreferences {
-    myUserPreferences {
-      items {
-        id
-        key
-        preference
-      }
-      total
-    }
-  }
-`
-
-const UPDATE_MY_USER_PREFERENCE = gql`
-  mutation UpdateMyUserPreference($key: String!, $preference: Object!) {
-    updateMyUserPreference(key: $key, preference: $preference) {
-      id
-      key
-      preference
-    }
-  }
-`
-
-export class UserPreferencesService {
-  public userPreferences = new Map<string, any>()
-
-  async fetchInitialPreferences() {
-    const result = await client.query({ query: GET_INITIAL_PREFERENCES })
-    result.data.myUserPreferences.items.forEach((pref: any) => {
-      this.userPreferences.set(pref.key, pref.preference)
-    })
-  }
-
-  async getPreference(key: string): Promise<any> {
-    if (this.userPreferences.has(key)) {
-      return this.userPreferences.get(key)
-    }
-
-    const result = await client.query({
-      query: GET_USER_PREFERENCE,
-      variables: { key }
-    })
-
-    const { preference } = result.data.myUserPreference
-    this.userPreferences.set(key, preference)
-
-    return preference
-  }
-
-  async updatePreference(key: string, newPreference: any) {
-    const result = await client.mutate({
-      mutation: UPDATE_MY_USER_PREFERENCE,
-      variables: { key, preference: newPreference }
-    })
-
-    const { preference } = result.data.updateMyUserPreference
-    this.userPreferences.set(key, preference)
-  }
-}

package/tsconfig.json

@@ -1,24 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "es2018",
-    "module": "esnext",
-    "moduleResolution": "node",
-    "noEmitOnError": true,
-    "lib": ["es2017", "dom"],
-    "strict": true,
-    "esModuleInterop": false,
-    "allowSyntheticDefaultImports": true,
-    "experimentalDecorators": true,
-    "useDefineForClassFields": false,
-    "importHelpers": true,
-    "outDir": "dist",
-    "sourceMap": true,
-    "inlineSources": true,
-    "rootDir": "./",
-    "declaration": true,
-    "incremental": true,
-    "skipLibCheck": true,
-    "types": ["node", "mocha"]
-  },
-  "include": ["**/*.ts"]
-}

package/web-dev-server.config.mjs

@@ -1,27 +0,0 @@
-// import { hmrPlugin, presets } from '@open-wc/dev-server-hmr';
-
-/** Use Hot Module replacement by adding --hmr to the start command */
-const hmr = process.argv.includes('--hmr');
-
-export default /** @type {import('@web/dev-server').DevServerConfig} */ ({
-  open: '/demo/',
-  /** Use regular watch mode if HMR is not enabled. */
-  watch: !hmr,
-  /** Resolve bare module imports */
-  nodeResolve: {
-    exportConditions: ['browser', 'development'],
-  },
-
-  /** Compile JS for older browsers. Requires @web/dev-server-esbuild plugin */
-  // esbuildTarget: 'auto'
-
-  /** Set appIndex to enable SPA routing */
-  // appIndex: 'demo/index.html',
-
-  plugins: [
-    /** Use Hot Module Replacement by uncommenting. Requires @open-wc/dev-server-hmr plugin */
-    // hmr && hmrPlugin({ exclude: ['**/*/node_modules/**/*'], presets: [presets.litElement] }),
-  ],
-
-  // See documentation for all available options
-});

package/web-test-runner.config.mjs

@@ -1,41 +0,0 @@
-// import { playwrightLauncher } from '@web/test-runner-playwright';
-
-const filteredLogs = ['Running in dev mode', 'lit-html is in dev mode'];
-
-export default /** @type {import("@web/test-runner").TestRunnerConfig} */ ({
-  /** Test files to run */
-  files: 'dist/test/**/*.test.js',
-
-  /** Resolve bare module imports */
-  nodeResolve: {
-    exportConditions: ['browser', 'development'],
-  },
-
-  /** Filter out lit dev mode logs */
-  filterBrowserLogs(log) {
-    for (const arg of log.args) {
-      if (typeof arg === 'string' && filteredLogs.some(l => arg.includes(l))) {
-        return false;
-      }
-    }
-    return true;
-  },
-
-  /** Compile JS for older browsers. Requires @web/dev-server-esbuild plugin */
-  // esbuildTarget: 'auto',
-
-  /** Amount of browsers to run concurrently */
-  // concurrentBrowsers: 2,
-
-  /** Amount of test files per browser to test concurrently */
-  // concurrency: 1,
-
-  /** Browsers to run tests on */
-  // browsers: [
-  //   playwrightLauncher({ product: 'chromium' }),
-  //   playwrightLauncher({ product: 'firefox' }),
-  //   playwrightLauncher({ product: 'webkit' }),
-  // ],
-
-  // See documentation for all available options
-});