@lls/typings 24.1.30-e0c8c826

package/internal/book.d.ts

@@ -0,0 +1,21 @@
+import type { Filter } from '@typings/models'
+
+type Collection = {
+  name?: string
+  year?: number
+  publisher?: string
+}
+
+export type Book = {
+  id?: number
+  valid?: boolean
+  subjects?: number[]
+  levels?: number[]
+  year?: number
+  textbooks?: number[]
+  displayTitle?: string
+  renderer?: string
+  filters?: Filter[]
+  chapters?: number[]
+  collection?: Collection
+}

package/internal/chapter.d.ts

@@ -0,0 +1,10 @@
+export type Chapter = {
+  id?: number
+  numShow?: string | number | null
+  releaseVersion?: number | null
+  oldChapter?: number | null
+  teaser?: boolean
+  valid?: boolean
+  book?: number | null
+  pages?: number[]
+}

package/internal/department.d.ts

@@ -0,0 +1,6 @@
+export type Department = {
+  id?: number
+  name?: string
+  zipcode?: string
+  academy?: number
+}

package/internal/filter.d.ts

@@ -0,0 +1,10 @@
+export type Filter = {
+  type?: string
+  title?: string
+  match?: {
+    thematicName?: string[]
+    premium?: boolean
+    isOriginal?: boolean
+  }
+  displayConditions?: { isTeacher?: boolean; isPremium?: boolean }
+}

package/internal/level.d.ts

@@ -0,0 +1,7 @@
+export type Level = {
+  id?: number
+  name?: string
+  code?: string
+  slug?: string
+  order?: number
+}

package/internal/license.d.ts

@@ -0,0 +1,4 @@
+export type License = {
+  id?: number
+  books?: number[]
+}

package/internal/page.d.ts

@@ -0,0 +1,132 @@
+import type { TODO } from '@typings/utils'
+
+export type ScreenMode = 'grid-xs' | 'grid-md'
+
+export type SubzoneTypeCategory = 'picWord' | 'definition' | 'subZone'
+
+export type ZoneType = {
+  id: string
+  x: number
+  y: number
+  w: number
+  h: number
+}
+export type ZoomZoneType = ZoneType & { type: Extract<SubzoneTypeCategory, 'subZone'> }
+export type DefinitionsType = ZoneType & { type: Extract<SubzoneTypeCategory, 'definition'> }
+export type PicWordType = ZoneType & { type: Extract<SubzoneTypeCategory, 'picWord'>; word?: string }
+
+export type SubZoneType = ZoomZoneType | DefinitionsType | PicWordType
+
+export type DocJson<T extends 'primary' | 'default' = 'default'> = {
+  id?: number
+  uuid?: string
+  contentMd?: string
+} & (T extends 'primary'
+  ? {
+      src?: string
+      picWords?: PicWordType[]
+      definitions?: DefinitionsType[]
+      subZones?: ZoomZoneType[]
+      audios?: string[]
+      videos?: string[]
+      rives?: { src: string; stateMachines: string }[]
+    }
+  : {
+      metadata?: TODO | null
+      rightResponses?: TODO
+      isIndexable?: boolean | null
+      renewalAddedAt?: string
+      renewalUpdatedAt?: string
+      annotations?: TODO
+      premium?: boolean | null
+      responses?:
+        | {
+            id: string
+            content: string
+            token?: string
+            step?: number
+            start?: number
+            end?: number
+            verb?: string
+            files?: Record<string, unknown>
+          }[]
+        | null
+    })
+
+export type PrimaryDoc = DocJson<'primary'>
+
+export type LayoutItem =
+  | {
+      id: string
+      root?: true
+      type: 'vgrid' | 'hgrid' | 'tabs' | 'tab' | 'workplan' | 'wpcard' | 'wptask' // copied from ITEM_TYPES
+      content: (LayoutItem | LayoutCell)[]
+      w?: number
+    }
+  | LayoutCell
+
+export type LayoutGrid = { content: LayoutItem[] }
+
+export type LayoutCell = {
+  id: string
+  type: 'cell'
+  content?: undefined
+  w?: number
+  autoheight?: boolean
+}
+
+export type PrimaryLayoutItem = {
+  id: string
+  x: number
+  y: number
+  w: number
+  h: number
+}
+
+export type Page<T extends 'primary' | 'default' = 'default'> = {
+  id?: number
+  contentMd?: string
+  renewalAddedAt?: string
+  isWorkplan?: boolean
+  isOriginal?: boolean
+  book?: number | null
+  chapter?: number | null
+  thematicName?: string
+  numericOrder?: number | null
+  valid?: boolean
+  premium?: boolean | null
+  isPanorama?: boolean
+  isCreatedFromScratch?: boolean
+  isDraft?: boolean
+  page?: number | null
+  nbPages?: number
+  isExercise?: boolean
+  isPartOfSession?: boolean
+  title?: string
+  slug?: string
+  originalPage?: number | null
+  parent?: number | null
+  hasNewDesign?: boolean
+  oldLesson?: number | boolean | null
+  createdAt?: string
+  updatedAt?: string
+  sharedAt?: string
+  seenAt?: string
+  user?: number | null
+  shouldRender?: boolean
+  isCustomized?: boolean
+  type?: string
+  metadata?: TODO | null
+} & (T extends 'primary'
+  ? {
+      children?: PrimaryDoc[]
+      layouts?: {
+        primary?: PrimaryLayoutItem[]
+      }
+    }
+  : {
+      children?: DocJson[]
+      layouts?: Partial<Record<ScreenMode, LayoutGrid>>
+    })
+
+export type PrimaryPage = Page<'primary'>

package/internal/school.d.ts

@@ -0,0 +1,6 @@
+export type School = {
+  id?: number
+  name?: string
+  city?: string
+  prefix?: string | null
+}

package/internal/schoolType.d.ts

@@ -0,0 +1,5 @@
+export type SchoolType = {
+  id?: number
+  name?: string
+  order?: number
+}

package/internal/subject.d.ts

@@ -0,0 +1,6 @@
+export type Subject = {
+  id?: number
+  name?: string | null
+  schoolTypes?: string[]
+  slug?: string
+}

package/internal/summary.d.ts

@@ -0,0 +1,4 @@
+export type Summary = {
+  id?: number
+  elements?: Summary[]
+}

package/internal/user.d.ts

@@ -0,0 +1,32 @@
+export type User = {
+  id?: number
+  isAdmin?: boolean
+  isEditorLLS?: boolean
+  isPremium?: boolean
+  isTrial?: boolean
+  isStudent?: boolean
+  isTeacher?: boolean
+  isReviewer?: boolean
+  academicEnabled?: boolean
+  firstname?: string | null
+  lastname?: string | null
+  email?: string | null
+  username?: string | null
+  gender?: string | null
+  functions?: string[] | null
+  subjects?: number[] | null
+  schools?: number[] | null
+  isGarUser?: boolean
+  passwordUpdateRequired?: boolean
+  confirmed?: boolean
+  userPages?: number[] | null
+  schoolTypes?: string[]
+}
+
+export type AdminUser = User & { isAdmin: true }
+export type EditorLLSUser = User & { isEditorLLS: true }
+export type PremiumUser = User & { isPremium: true }
+export type TrialUser = User & { isTrial: true }
+export type StudentUser = User & { isStudent: true }
+export type TeacherUser = User & { isTeacher: true }
+export type AcademicEnabledUser = TeacherUser & { academicEnabled: true }

package/models.d.ts

@@ -0,0 +1,12 @@
+export * from './internal/book'
+export * from './internal/chapter'
+export * from './internal/department'
+export * from './internal/filter'
+export * from './internal/level'
+export * from './internal/license'
+export * from './internal/page'
+export * from './internal/school'
+export * from './internal/schoolType'
+export * from './internal/subject'
+export * from './internal/summary'
+export * from './internal/user'

package/overrides/cheerio.d.ts

@@ -0,0 +1,6 @@
+import type CheerioModule from 'cheerio'
+
+declare global {
+  // https://stackoverflow.com/questions/35074713/extending-typescript-global-object-in-node-js
+  var cheerio: typeof CheerioModule
+}

package/overrides/cssModule.d.ts

@@ -0,0 +1,7 @@
+declare module '*.module.css'
+
+namespace React {
+  interface CSSProperties {
+    [key: `--${string}`]: string | number
+  }
+}

package/overrides/html-to-react.d.ts

@@ -0,0 +1,35 @@
+declare module 'html-to-react' {
+  import type { Element as DomHandlerElement, Node as DomHandlerNode, DomElement as DomHandlerDomElement } from 'domhandler'
+  // TODO: Element is clearly inaccurate. It misses accessors like tagName, attributes
+
+  export type Node = DomHandlerNode
+  export type Element = DomHandlerElement
+  export type DomElement = DomHandlerDomElement
+  export interface ProcessingInstruction {
+    shouldProcessNode: (node: Node) => boolean | undefined
+    processNode: (node: Node, children: Element['children'], siblingKey: any) => unknown
+  }
+
+  class Parser {
+    constructor(options: { recognizeSelfClosing: boolean })
+
+    parse: (html: string) => any
+    parseWithInstructions: (
+      html: string,
+      isValidNode: any,
+      processingInstructions: ProcessingInstruction[],
+      preprocessingInstructions?: ProcessingInstruction[]
+    ) => unknown
+  }
+
+  class ProcessNodeDefinitions {
+    constructor(param: unknown)
+
+    processDefaultNode: (node: Node, children: Element['children'], index: number) => any
+  }
+
+  export default {
+    Parser,
+    ProcessNodeDefinitions
+  }
+}

package/overrides/lodash.d.ts

@@ -0,0 +1,43 @@
+import type lo from 'lodash'
+import type _ from 'lodash/fp'
+import type { ValueOf } from '../utils.d.ts'
+
+declare module 'lodash/fp.js' {
+  interface LodashMap {
+    convert: (a: { cap: false }) => <Iterable, TResult>(
+      iteratee: (value: Iterable extends Array<infer T> ? T : ValueOf<Iterable>, idx: Iterable extends any[] ? number : keyof Iterable) => TResult,
+      collection: Iterable
+    ) => TResult[]
+  }
+
+  interface LodashForEach {
+    convert: (a: { cap: false }) => <Iterable, TResult>(
+      iteratee: (value: Iterable extends Array<infer T> ? T : ValueOf<Iterable>, idx: Iterable extends any[] ? number : keyof Iterable) => TResult,
+      collection: Iterable
+    ) => void
+  }
+
+  interface LodashSome {
+    convert: (a: { cap: false }) => LodashSome
+  }
+
+  interface LodashReplace {
+    // biome-ignore lint/style/useShorthandFunctionType:
+    (pattern: RegExp | string, replacement: lo.ReplaceFunction | string, string: string | number | undefined): string
+  }
+
+  interface LodashStartsWith extends _.LodashStartsWith {
+    (target?: unknown): _.LodashStartsWith1x1
+    (target?: unknown, string?: unknown): boolean
+  }
+
+  interface LodashParseInt {
+    (radix: number, string: string | number | undefined): number
+    (radix: number): (string: string | number | undefined) => number
+  }
+
+  interface LodashReject {
+    // biome-ignore lint/style/useShorthandFunctionType:
+    <T>(predicate: unknown, collection: T): T
+  }
+}

package/overrides/window.d.ts

@@ -0,0 +1,37 @@
+type TPianoOpts = {
+  user_id?: string | undefined
+  user_category?: string | undefined
+} & Record<string, unknown>
+
+interface Window {
+  opera: any | undefined
+  MSStream: any | undefined
+  coreOpenWindow?: typeof window.open
+  coreHref?: string
+  pa?: {
+    user?: {
+      setUser?: (user_id: TPianoOpts['user_id'], user_category: TPianoOpts['user_category']) => void
+    }
+    sendEvent?: (name: string, opts: TPianoOpts) => void
+  }
+  playwrightInplaceNavigate: (value: string) => void
+  playwrightStoryId: string
+}
+
+type requestFullscreenType = (typeof Element.prototype)['requestFullscreen']
+
+interface Element {
+  mozRequestFullScreen: requestFullscreenType
+  webkitRequestFullscreen: requestFullscreenType
+  msRequestFullscreen: requestFullscreenType
+}
+
+type exitFullscreenType = (typeof Document.prototype)['exitFullscreen']
+interface Document {
+  webkitFullscreenElement: Element | null
+  mozFullScreenElement: Element | null
+  webkitExitFullscreen: exitFullscreenType
+  mozExitFullscreen: exitFullscreenType
+  msExitFullscreen: exitFullscreenType
+  outerHTML: unknown
+}

package/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "@lls/typings",
+  "version": "24.1.30-e0c8c826",
+  "description": "",
+  "main": "index.js",
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "devDependencies": {
+    "@types/domhandler": "2.4.5",
+    "@types/lodash": "4.14.202",
+    "@types/react": "18.2.45",
+    "typescript": "5.4.5"
+  },
+  "peerDependencies": {
+    "@biomejs/biome": "*"
+  },
+  "scripts": {
+    "dts": "pnpm tsc --project tsconfig.production.json",
+    "lint": "pnpm biome check --apply *.d.ts internal overrides",
+    "test": "echo \"Error: no test specified\" && exit 0"
+  }
+}

package/presentationProps.d.ts

@@ -0,0 +1,38 @@
+import type { ReactSetState } from '@typings/react'
+
+type ZoomPropsType = {
+  zoomStep?: number
+  zoom: number
+  resetZoom?: (resetStep: number) => void
+  increaseZoom?: () => void
+  decreaseZoom?: () => void
+}
+export type PresentationViewType = {
+  view?: 'page' | 'slide' | 'split' | undefined
+  uuids?: (string | undefined)[]
+  uuid?: string
+  lastOpenUuid?: string
+}
+export type PresentationPropsType = {
+  isPresentationMode?: boolean
+  isPaginationEnabled?: boolean
+  presentationView?: PresentationViewType
+  preSlideDocUuid?: string
+  viewerZoomProps?: ZoomPropsType
+  leftDocZoomProps?: ZoomPropsType
+  rightDocZoomProps?: ZoomPropsType
+  isLaserCursor?: boolean
+  setIsLaserCursor?: ReactSetState<boolean>
+  openProjectorView?: () => void
+  extendSplitView?: (view: -1 | 0 | 1) => void
+  closeFullscreenCard?: (docUuid: string) => void
+  closeProjectorView?: () => void
+  closeSplitView?: () => void
+  openFullscreenCard?: (docUuid: string, forceSplit: boolean) => void
+  slideToPreviousDocument?: (currentDocUuid: string, tabId: string) => void
+  getChildPosition?: (docUuid?: string, tabId?: string) => number
+  slideToNextDocument?: (currentDocUuid: string, tabId: string) => void
+  initZoomModal?: (docUuid?: string) => void
+  deleteZoomModal?: (docUuid?: string) => void
+  getNbDocs?: (tabId: string) => number
+}

package/project.json

@@ -0,0 +1,9 @@
+{
+  "name": "@typings",
+  "targets": {
+    "build": {
+      "dependsOn": [],
+      "executor": "nx:noop"
+    }
+  }
+}

package/react.d.ts

@@ -0,0 +1,32 @@
+export type ReactChildren = React.ReactNode | undefined
+
+export type AnyComponent = (...args: any[]) => JSX.Element
+
+export type ReactSetState<T> = React.Dispatch<React.SetStateAction<T>>
+
+export type DataAttributesType = {
+  [key in `data-${string}`]: unknown
+}
+
+type ArialAttributesType = {
+  [key in `aria-${string}`]: unknown
+}
+
+export type CommonPropsType = {
+  children?: ReactChildren
+  dangerouslySetInnerHTML?:
+    | {
+        __html: string
+      }
+    | undefined
+  className?: string | undefined
+  contentEditable?: boolean | 'inherit' | undefined
+  id?: string | undefined
+  placeholder?: string | undefined
+  style?: React.CSSProperties | undefined
+  tabIndex?: number | undefined
+  title?: string | undefined
+  role?: React.AriaRole | undefined
+}
+
+export type AllowedPropsType = DataAttributesType & ArialAttributesType & CommonPropsType

package/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "./tsconfig.production.json",
+  "compilerOptions": {
+    "declaration": false,
+    "noEmit": true,
+    "emitDeclarationOnly": false
+  }
+}

package/tsconfig.production.json

@@ -0,0 +1,7 @@
+{
+  "extends": "../tsconfig.base.json",
+  "compilerOptions": {
+    "types": [],
+    "outDir": "builttypes"
+  }
+}

package/utils.d.ts

@@ -0,0 +1,12 @@
+export type TODO = any
+
+export type AnyFunction = (...args: any[]) => void
+
+export type RequireAtLeastOne<T, Keys extends keyof T = keyof T> = Pick<T, Exclude<keyof T, Keys>> &
+  {
+    [K in Keys]-?: Required<Pick<T, K>> & Partial<Pick<T, Exclude<Keys, K>>>
+  }[Keys]
+
+export type ValueOf<T> = T[keyof T]
+
+export type ArrayElement<T> = T extends readonly (infer I)[] ? I : never