@mdn/fred 0.0.1

package/types/github.ts

@@ -0,0 +1,200 @@
+export type SimpleUser = {
+  name: string | null;
+  email: string | null;
+  login: string;
+  id: number;
+  node_id: string;
+  avatar_url: string;
+  gravatar_id: string | null;
+  url: string;
+  html_url: string;
+  followers_url: string;
+  following_url: string;
+  gists_url: string;
+  starred_url: string;
+  subscriptions_url: string;
+  organizations_url: string;
+  repos_url: string;
+  events_url: string;
+  received_events_url: string;
+  type: string;
+  site_admin: boolean;
+  starred_at?: string;
+  user_view_type?: string;
+};
+
+export type Label = {
+  id: number;
+  node_id: string;
+  url: string;
+  name: string;
+  description: string | null;
+  color: string | null;
+  default: boolean;
+};
+
+export type Milestone = {
+  url: string;
+  html_url: string;
+  labels_url: string;
+  id: number;
+  node_id: string;
+  number: number;
+  state: "open" | "closed";
+  title: string;
+  description: string | null;
+  creator: SimpleUser | null;
+  open_issues: number;
+  closed_issues: number;
+  created_at: string;
+  updated_at: string;
+  closed_at: string | null;
+  due_on: string | null;
+};
+
+export type PullRequestInfo = {
+  merged_at: string | null;
+  diff_url: string | null;
+  html_url: string | null;
+  patch_url: string | null;
+  url: string | null;
+};
+
+export type IssueTypeProperty = {
+  id: number;
+  node_id: string;
+  name: string;
+  description: string | null;
+  color:
+    | "gray"
+    | "blue"
+    | "green"
+    | "yellow"
+    | "orange"
+    | "red"
+    | "pink"
+    | "purple"
+    | null;
+  created_at: string;
+  updated_at: string;
+  is_enabled: boolean;
+};
+
+export type AuthorAssociation =
+  | "COLLABORATOR"
+  | "CONTRIBUTOR"
+  | "FIRST_TIMER"
+  | "FIRST_TIME_CONTRIBUTOR"
+  | "MANNEQUIN"
+  | "MEMBER"
+  | "NONE"
+  | "OWNER";
+
+export type Reactions = {
+  url: string;
+  total_count: number;
+  "+1": number;
+  "-1": number;
+  laugh: number;
+  confused: number;
+  heart: number;
+  hooray: number;
+  eyes: number;
+  rocket: number;
+};
+
+export type SubIssuesSummary = {
+  total: number;
+  completed: number;
+  percent_completed: number;
+};
+
+export type Repository = {
+  /** Many repository fields omitted for brevity; include as needed */
+  id: number;
+  node_id: string;
+  name: string;
+  full_name: string;
+  private: boolean;
+  html_url: string;
+  description: string | null;
+  fork: boolean;
+  url: string;
+  // ... (other properties)
+};
+
+export type GitHubAppOwnerSimpleUser = SimpleUser;
+
+export type GitHubAppOwnerEnterprise = {
+  id: number;
+  node_id: string;
+  name: string;
+  slug: string;
+  html_url: string;
+  website_url: string | null;
+  description: string | null;
+  created_at: string | null;
+  updated_at: string | null;
+  avatar_url: string;
+};
+
+export type GitHubApp = {
+  id: number;
+  slug: string;
+  node_id: string;
+  client_id: string;
+  owner: GitHubAppOwnerSimpleUser | GitHubAppOwnerEnterprise;
+  name: string;
+  description: string | null;
+  external_url: string;
+  html_url: string;
+  created_at: string;
+  updated_at: string;
+  permissions: Record<string, string>;
+  events: string[];
+  installations_count: number;
+  client_secret?: string;
+  webhook_secret?: string | null;
+  pem?: string;
+};
+
+export type Issue = {
+  id: number;
+  node_id: string;
+  url: string;
+  repository_url: string;
+  labels_url: string;
+  comments_url: string;
+  events_url: string;
+  html_url: string;
+  number: number;
+  state: "open" | "closed";
+  state_reason: "completed" | "reopened" | "not_planned" | null;
+  title: string;
+  body: string | null;
+  user: SimpleUser | null;
+  labels: Array<string | Label>;
+  assignee: SimpleUser | null;
+  assignees: SimpleUser[] | null;
+  milestone: Milestone | null;
+  locked: boolean;
+  active_lock_reason: string | null;
+  comments: number;
+  pull_request: PullRequestInfo;
+  closed_at: string | null;
+  created_at: string;
+  updated_at: string;
+  draft: boolean;
+  closed_by: SimpleUser | null;
+  body_html: string;
+  body_text: string;
+  timeline_url: string;
+  type: IssueTypeProperty | null;
+  repository: Repository;
+  performed_via_github_app: GitHubApp | null;
+  author_association: AuthorAssociation;
+  reactions: Reactions;
+  sub_issues_summary: SubIssuesSummary;
+};
+
+export type Issues = Issue[];

package/types/lit.ts

@@ -0,0 +1,7 @@
+import { UnsafeHTMLDirective } from "lit-html/directives/unsafe-html.js";
+import { DirectiveResult } from "lit/directive.js";
+
+export * from "lit";
+export * from "lit/directives/ref.js";
+
+export type L10nResult = DirectiveResult<typeof UnsafeHTMLDirective>;

package/types/modules.d.ts

@@ -0,0 +1,34 @@
+declare module "*.css?lit" {
+  const css: import("lit").CSSResult;
+  export default css;
+}
+
+declare module "*.svg?lit" {
+  const svg: import("lit").SVGTemplateResult;
+  export default svg;
+}
+
+declare module "*.svg" {
+  const url: string;
+  export default url;
+}
+
+declare module "*.ftl" {
+  const ftl: string;
+  export default ftl;
+}
+
+declare module "*?url" {
+  const url: string;
+  export default url;
+}
+
+declare module "*?source" {
+  const source: string;
+  export default source;
+}
+
+declare module "*?source&csp=true" {
+  const source: string;
+  export default source;
+}

package/types/observatory.ts

@@ -0,0 +1,109 @@
+export interface AnalyzeRequest {
+  // The host to analyze.
+  host: string;
+}
+
+export type ScanState =
+  | "ABORTED"
+  | "FAILED"
+  | "FINISHED"
+  | "PENDING"
+  | "STARTING"
+  | "RUNNING";
+
+export interface Result {
+  scan: ScanResult;
+  tests: TestResult;
+  history: HistoryResult[];
+}
+
+export interface GradeDistribution {
+  grade: string;
+  count: number;
+}
+
+export interface ScanResult {
+  algorithm_version: number;
+  scanned_at: string;
+  error?: string | null;
+  grade?: string | null;
+  id: number;
+  response_headers?: Record<string, string>;
+  score?: number;
+  status_code?: number;
+  tests_failed: number;
+  tests_passed: number;
+  tests_quantity: number;
+}
+
+export type TestResult = Record<string, IndividualTest>;
+
+export interface IndividualTest {
+  data: CookiesData | null;
+  expectation: string;
+  name: string;
+  title: string;
+  link: string;
+  pass: boolean;
+  result: string;
+  score_description: string;
+  recommendation: string;
+  score_modifier: number;
+  policy?: CSPPolicy;
+  route?: string[];
+}
+
+export interface HistoryResult {
+  scanned_at: string;
+  grade: string;
+  id: number;
+  score: number;
+}
+
+export type CookiesData = Record<string, IndividualCookie>;
+
+export interface IndividualCookie {
+  domain: string;
+  expires: string;
+  httponly: boolean;
+  path: string;
+  samesite: string;
+  secure: boolean;
+}
+
+export interface PolicyItem {
+  pass: boolean | null;
+  description: string;
+  info: string;
+}
+
+export interface CSPPolicy {
+  antiClickjacking: PolicyItem;
+  defaultNone: PolicyItem;
+  insecureBaseUri: PolicyItem;
+  insecureFormAction: PolicyItem;
+  insecureSchemeActive: PolicyItem;
+  insecureSchemePassive: PolicyItem;
+  strictDynamic: PolicyItem;
+  unsafeEval: PolicyItem;
+  unsafeInline: PolicyItem;
+  unsafeInlineStyle: PolicyItem;
+  unsafeObjects: PolicyItem;
+}
+
+// test + scoring documentation response
+export interface ScoringCategory {
+  name: string;
+  title: string;
+  mdnLink: string;
+  results: ScoringResultDefinition[];
+}
+
+export interface ScoringResultDefinition {
+  name: string;
+  scoreModifier: number;
+  description: string;
+  recommendation: string;
+}
+
+export type ScoringResponse = ScoringCategory[];

package/types/rari.ts

@@ -0,0 +1 @@
+export * from "@mdn/rari";

package/utils/glean.js

@@ -0,0 +1,21 @@
+// @ts-expect-error "Could not find declaration file"
+import GleanMetrics from "@mozilla/glean/metrics";
+
+/**
+ * Records a click event.
+ *
+ * Use only if automatic click events are not an option.
+ * See: https://mozilla.github.io/glean.js/automatic_instrumentation/click_events/
+ *
+ * @param {string} id
+ * @param {object} options
+ * @param {string=} options.type
+ * @param {string=} options.label
+ */
+export function gleanClick(id, { type, label }) {
+  GleanMetrics.recordElementClick({
+    id,
+    type,
+    label,
+  });
+}

package/vendor/yari/libs/play/index.d.ts

@@ -0,0 +1,62 @@
+/** @import { IncomingMessage, ServerResponse } from "http" */
+/** @import * as express from "express" */
+/**
+ * @typedef State
+ * @property {string} html
+ * @property {string} css
+ * @property {string} js
+ * @property {string} [src]
+ */
+/**
+ * @param {ServerResponse<IncomingMessage>} res
+ */
+export function withRunnerResponseHeaders(
+  res: ServerResponse<IncomingMessage>,
+): void;
+/**
+ * @param {State | null} state
+ * @param {string} hrefWithCode
+ * @param {string} searchWithState
+ */
+export function renderWarning(
+  state: State | null,
+  hrefWithCode: string,
+  searchWithState: string,
+): string;
+/**
+ * @param {State | null} [state=null]
+ */
+export function renderHtml(state?: State | null | undefined): string;
+/**
+ * @param {string | null} base64String
+ */
+export function decompressFromBase64(base64String: string | null): Promise<
+  | {
+      state: null;
+      hash: null;
+    }
+  | {
+      state: string;
+      hash: string;
+    }
+>;
+/**
+ * @param {express.Request} req
+ * @param {express.Response} res
+ */
+export function handleRunner(
+  req: express.Request,
+  res: express.Response,
+): Promise<express.Response<any, Record<string, any>>>;
+export const ORIGIN_PLAY: string;
+export const ORIGIN_MAIN: string;
+export const PLAYGROUND_UNSAFE_CSP_VALUE: string;
+export type State = {
+  html: string;
+  css: string;
+  js: string;
+  src?: string | undefined;
+};
+import type { IncomingMessage } from "http";
+import type { ServerResponse } from "http";
+import type * as express from "express";