Skip to content

Commit 0c927d0

Browse files
committed
feat: ✨ init libarc
1 parent fc0f3ed commit 0c927d0

File tree

7 files changed

+274
-6
lines changed

7 files changed

+274
-6
lines changed

.gitignore

+175-6
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,175 @@
1-
source
2-
result
3-
node_modules
4-
pnpm-lock.yaml
5-
bun.lockb
6-
package-lock.json
1+
# Based on https://raw.githubusercontent.com/github/gitignore/main/Node.gitignore
2+
3+
# Logs
4+
5+
logs
6+
_.log
7+
npm-debug.log_
8+
yarn-debug.log*
9+
yarn-error.log*
10+
lerna-debug.log*
11+
.pnpm-debug.log*
12+
13+
# Caches
14+
15+
.cache
16+
17+
# Diagnostic reports (https://nodejs.org/api/report.html)
18+
19+
report.[0-9]_.[0-9]_.[0-9]_.[0-9]_.json
20+
21+
# Runtime data
22+
23+
pids
24+
_.pid
25+
_.seed
26+
*.pid.lock
27+
28+
# Directory for instrumented libs generated by jscoverage/JSCover
29+
30+
lib-cov
31+
32+
# Coverage directory used by tools like istanbul
33+
34+
coverage
35+
*.lcov
36+
37+
# nyc test coverage
38+
39+
.nyc_output
40+
41+
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
42+
43+
.grunt
44+
45+
# Bower dependency directory (https://bower.io/)
46+
47+
bower_components
48+
49+
# node-waf configuration
50+
51+
.lock-wscript
52+
53+
# Compiled binary addons (https://nodejs.org/api/addons.html)
54+
55+
build/Release
56+
57+
# Dependency directories
58+
59+
node_modules/
60+
jspm_packages/
61+
62+
# Snowpack dependency directory (https://snowpack.dev/)
63+
64+
web_modules/
65+
66+
# TypeScript cache
67+
68+
*.tsbuildinfo
69+
70+
# Optional npm cache directory
71+
72+
.npm
73+
74+
# Optional eslint cache
75+
76+
.eslintcache
77+
78+
# Optional stylelint cache
79+
80+
.stylelintcache
81+
82+
# Microbundle cache
83+
84+
.rpt2_cache/
85+
.rts2_cache_cjs/
86+
.rts2_cache_es/
87+
.rts2_cache_umd/
88+
89+
# Optional REPL history
90+
91+
.node_repl_history
92+
93+
# Output of 'npm pack'
94+
95+
*.tgz
96+
97+
# Yarn Integrity file
98+
99+
.yarn-integrity
100+
101+
# dotenv environment variable files
102+
103+
.env
104+
.env.development.local
105+
.env.test.local
106+
.env.production.local
107+
.env.local
108+
109+
# parcel-bundler cache (https://parceljs.org/)
110+
111+
.parcel-cache
112+
113+
# Next.js build output
114+
115+
.next
116+
out
117+
118+
# Nuxt.js build / generate output
119+
120+
.nuxt
121+
dist
122+
123+
# Gatsby files
124+
125+
# Comment in the public line in if your project uses Gatsby and not Next.js
126+
127+
# https://nextjs.org/blog/next-9-1#public-directory-support
128+
129+
# public
130+
131+
# vuepress build output
132+
133+
.vuepress/dist
134+
135+
# vuepress v2.x temp and cache directory
136+
137+
.temp
138+
139+
# Docusaurus cache and generated files
140+
141+
.docusaurus
142+
143+
# Serverless directories
144+
145+
.serverless/
146+
147+
# FuseBox cache
148+
149+
.fusebox/
150+
151+
# DynamoDB Local files
152+
153+
.dynamodb/
154+
155+
# TernJS port file
156+
157+
.tern-port
158+
159+
# Stores VSCode versions used for testing VSCode extensions
160+
161+
.vscode-test
162+
163+
# yarn v2
164+
165+
.yarn/cache
166+
.yarn/unplugged
167+
.yarn/build-state.yml
168+
.yarn/install-state.gz
169+
.pnp.*
170+
171+
# IntelliJ based IDEs
172+
.idea
173+
174+
# Finder (MacOS) folder config
175+
.DS_Store

libarc/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# libarc
2+
3+
`libarc` allows other browsers to integrate Arc.net features like the Boost Gallery, quote links, and more.

libarc/bun.lockb

37.9 KB
Binary file not shown.

libarc/package.json

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{
2+
"name": "libarc",
3+
"module": "src/index.ts",
4+
"type": "module",
5+
"devDependencies": {
6+
"@types/bun": "latest"
7+
},
8+
"peerDependencies": {
9+
"typescript": "^5.0.0"
10+
},
11+
"dependencies": {
12+
"firebase": "^10.11.1"
13+
}
14+
}

libarc/src/index.test.ts

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
import { test, expect } from "bun:test"
2+
import { quote } from "."
3+
4+
test("Quote from a public URL can be generated and redirects to the original URL", async () => {
5+
const url = await quote(
6+
process.env.ARC_TOKEN!,
7+
"https://cetera.uk",
8+
"Etcetera Development",
9+
"Wave smiley"
10+
)
11+
12+
console.log(url)
13+
14+
const res = await fetch(url).then((res) => res.text())
15+
16+
// Arc's shortened URLs are not HTTP redirects
17+
expect(res).toContain('canonical" href="https://cetera.uk/')
18+
})

libarc/src/index.ts

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
2+
/**
3+
* Generate a quote embed
4+
* @param url The URL to redirect to. In Arc, the URL always contains a [text fragment](https://developer.mozilla.org/en-US/docs/Web/Text_fragments), but this is not validated server-side.
5+
* @param title The title of the webpage. Displayed
6+
* @param quote The quote from the webpage to display
7+
*/
8+
export async function quote (
9+
token: string,
10+
url: string,
11+
title: string,
12+
quote: string
13+
): Promise<string> {
14+
const res = await fetch(
15+
"https://us-central1-bcny-arc-server.cloudfunctions.net/createRedirectLink",
16+
{
17+
method: "POST",
18+
headers: {
19+
"Content-Type": "application/json",
20+
Authorization: `Bearer ${token}`,
21+
},
22+
body: JSON.stringify({
23+
data: {
24+
url,
25+
title,
26+
quote,
27+
},
28+
}),
29+
}
30+
).then((res) => res.json())
31+
32+
if (res.error) {
33+
throw new Error(`Arc API error: ${res.error.message} (${res.error.status})`)
34+
}
35+
36+
return res.result.url
37+
}

libarc/tsconfig.json

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
{
2+
"compilerOptions": {
3+
// Enable latest features
4+
"lib": ["ESNext", "DOM"],
5+
"target": "ESNext",
6+
"module": "ESNext",
7+
"moduleDetection": "force",
8+
"jsx": "react-jsx",
9+
"allowJs": true,
10+
11+
// Bundler mode
12+
"moduleResolution": "bundler",
13+
"allowImportingTsExtensions": true,
14+
"verbatimModuleSyntax": true,
15+
"noEmit": true,
16+
17+
// Best practices
18+
"strict": true,
19+
"skipLibCheck": true,
20+
"noFallthroughCasesInSwitch": true,
21+
22+
// Some stricter flags (disabled by default)
23+
"noUnusedLocals": false,
24+
"noUnusedParameters": false,
25+
"noPropertyAccessFromIndexSignature": false
26+
}
27+
}

0 commit comments

Comments
 (0)