Merge branch 'feat/qr-code-enh' into chore/all-my-stuffs

# Conflicts:
#	components.d.ts
#	package.json
#	pnpm-lock.yaml
This commit is contained in:
ShareVB committed 2024-11-03 21:21:36 +01:00
commit 5c5e865b5c
5 files changed
+369 -30

No files matched your search

+3
View File
@@ -197,6 +197,9 @@
"turndown": "^7.1.2",
"roboto-base64": "^0.1.2",
"silly-password-generator": "^1.0.28",
"pp-qr-code": "^0.6.3",
"qrcode": "^1.5.1",
"qrcode-terminal-nooctal": "^0.12.1",
"sql-formatter": "^13.0.0",
"svg2png-wasm": "^1.4.1",
"svg-to-url": "^4.0.0",
+24 -1
View File
@@ -386,6 +386,9 @@ dependencies:
potrace:
specifier: ^2.1.8
version: 2.1.8
pp-qr-code:
specifier: ^0.6.3
version: 0.6.4
pretty-ms:
specifier: ^9.1.0
version: 9.1.0
@@ -398,6 +401,9 @@ dependencies:
qrcode:
specifier: ^1.5.1
version: 1.5.1
qrcode-terminal-nooctal:
specifier: ^0.12.1
version: 0.12.1
randexp:
specifier: ^0.5.3
version: 0.5.3
@@ -6219,7 +6225,7 @@ packages:
/@vueuse/shared@10.0.0(vue@3.3.4):
resolution: {integrity: sha512-Zh3LgJqvUBWVY3SiMvXanTcfAneGbt63QPczBRDNgQ6jd/ehodO9a1lCFzaA6SWJJoI+ugVTjHFYJdoR656DVQ==}
dependencies:
vue-demi: 0.14.5(vue@3.3.4)
vue-demi: 0.14.10(vue@3.3.4)
transitivePeerDependencies:
- '@vue/composition-api'
- vue
@@ -10077,6 +10083,7 @@ packages:
/jsesc@2.5.2:
resolution: {integrity: sha512-OYu7XEzjkCQ3C5Ps3QIZsQfNpqoJyZZA99wd9aWd05NCtC5pWOkShK2mkL6HXQR6/Cy2lbNdPlZBpuQHXE63gA==}
engines: {node: '>=4'}
hasBin: true
/jsesc@3.0.2:
resolution: {integrity: sha512-xKqzzWXDttJuOcawBt4KnKHHIf5oQ/Cxax+0PWFG+DFDgHNAdi+TXECADI+RYiFUMmx8792xsMbbgXj4CwnP4g==}
@@ -11665,6 +11672,12 @@ packages:
- debug
dev: false
/pp-qr-code@0.6.4:
resolution: {integrity: sha512-6OhfzsFgZClbBh3XzfwysSwH4injljeMreKaZyxWydthkhXAdjSbFfEtrvfHt1SN65PmAHEOux+dOVvJRiOaDw==}
dependencies:
qrcode-generator: 1.4.4
dev: false
/prebuild-install@7.1.2:
resolution: {integrity: sha512-UnNke3IQb6sgarcZIDU3gbMeTp/9SSU1DAIkil7PrqG1vZlBtY5msYccSKSHDqa3hNg436IXK+SNImReuA1wEQ==}
engines: {node: '>=10'}
@@ -11976,6 +11989,15 @@ packages:
'@types/emscripten': 1.39.13
dev: false
/qrcode-generator@1.4.4:
resolution: {integrity: sha512-HM7yY8O2ilqhmULxGMpcHSF1EhJJ9yBj8gvDEuZ6M+KGJ0YY2hKpnXvRD+hZPLrDVck3ExIGhmPtSdcjC+guuw==}
dev: false
/qrcode-terminal-nooctal@0.12.1:
resolution: {integrity: sha512-jy/kkD0iIMDjTucB+5T6KBsnirlhegDH47vHgrj5MejchSQmi/EAMM0xMFeePgV9CJkkAapNakpVUWYgHvtdKg==}
hasBin: true
dev: false
/qrcode@1.5.1:
resolution: {integrity: sha512-nS8NJ1Z3md8uTjKtP+SGGhfqmTCs5flU/xR623oI0JX+Wepz9R8UrRVCTBTJm3qGw3rH6jJ6MUHjkDx15cxSSg==}
engines: {node: '>=10.13.0'}
@@ -14795,6 +14817,7 @@ packages:
/yamljs@0.3.0:
resolution: {integrity: sha512-C/FsVVhht4iPQYXOInoxUM/1ELSf9EsgKH34FofQOp6hwCPrW4vG4w5++TED3xRUo8gD7l0P1J1dLlDYzODsTQ==}
hasBin: true
dependencies:
argparse: 1.0.10
glob: 7.2.3
+173 -14
View File
@@ -1,26 +1,89 @@
<script setup lang="ts">
import type { QRCodeErrorCorrectionLevel } from 'qrcode';
import { useQRCode } from './useQRCode';
import type {
CornerDotType,
CornerSquareType,
DotType,
ErrorCorrectionLevel,
FileExtension,
} from 'pp-qr-code';
import qrcodeConsole from 'qrcode-terminal-nooctal';
import { useQRCodeStyling } from './useQRCode';
import { useDownloadFileFromBase64 } from '@/composable/downloadBase64';
import { useQueryParamOrStorage } from '@/composable/queryParams';
const foreground = ref('#000000ff');
const background = ref('#ffffffff');
const errorCorrectionLevel = ref<QRCodeErrorCorrectionLevel>('medium');
const foreground = useQueryParamOrStorage({ name: 'fg', storageName: 'qr-code-gen:fg', defaultValue: '#000000ff' });
const background = useQueryParamOrStorage({ name: 'bg', storageName: 'qr-code-gen:bg', defaultValue: '#ffffffff' });
const errorCorrectionLevelSelectValue = useQueryParamOrStorage<string>({ name: 'level', storageName: 'qr-code-gen:level', defaultValue: 'medium' });
const errorCorrectionLevel = computed(() => errorCorrectionLevelSelectValue.value.toString()[0].toUpperCase() as ErrorCorrectionLevel);
const width = useQueryParamOrStorage({ name: 'width', storageName: 'qr-code-gen:width', defaultValue: 1024 });
const margin = useQueryParamOrStorage({ name: 'margin', storageName: 'qr-code-gen:margin', defaultValue: 10 });
const imageSize = useQueryParamOrStorage({ name: 'imgsize', storageName: 'qr-code-gen:imsz', defaultValue: 0.4 });
const imageMargin = useQueryParamOrStorage({ name: 'imgmargin', storageName: 'qr-code-gen:immg', defaultValue: 20 });
const outputType = useQueryParamOrStorage<FileExtension>({ name: 'out', storageName: 'qr-code-gen:out', defaultValue: 'png' });
const dotType = useQueryParamOrStorage<DotType>({ name: 'dot', storageName: 'qr-code-gen:dot', defaultValue: 'square' });
const dotColor = useQueryParamOrStorage<string>({ name: 'dotc', storageName: 'qr-code-gen:dotc', defaultValue: '#ffffffff' });
const cornersDotType = useQueryParamOrStorage<CornerDotType>({ name: 'cdt', storageName: 'qr-code-gen:cdt', defaultValue: 'square' });
const cornersDotColor = useQueryParamOrStorage<string>({ name: 'cdtc', storageName: 'qr-code-gen:cdtc', defaultValue: '#ffffffff' });
const cornersSquareType = useQueryParamOrStorage<CornerSquareType>({ name: 'cst', storageName: 'qr-code-gen:cst', defaultValue: 'square' });
const cornersSquareColor = useQueryParamOrStorage<string>({ name: 'cstc', storageName: 'qr-code-gen:cstc', defaultValue: '#ffffffff' });
const smallTerminal = useQueryParamOrStorage<boolean>({ name: 'sml', storageName: 'qr-code-gen:sml', defaultValue: false });
const fileInput = ref() as Ref<File>;
const { base64: imageBase64 } = useBase64(fileInput);
async function onUpload(file: File) {
if (file) {
fileInput.value = file;
}
}
const errorCorrectionLevels = ['low', 'medium', 'quartile', 'high'];
const outputTypes = ['svg', 'png', 'jpeg', 'webp'];
const dotTypes = ['dots',
'random-dots',
'rounded',
'vertical-lines',
'horizontal-lines',
'classy',
'classy-rounded',
'square',
'extra-rounded'];
const cornersDotTypes = ['dot', 'square', 'heart'];
const cornersSquareTypes = ['dot', 'square', 'extra-rounded'];
const text = ref('https://it-tools.tech');
const { qrcode } = useQRCode({
const { qrcode } = useQRCodeStyling({
text,
color: {
background,
foreground,
},
color: { background, foreground },
errorCorrectionLevel,
options: { width: 1024 },
imageBase64,
imageOptions: { imageSize, margin: imageMargin },
dotOptions: { type: dotType, color: dotColor },
cornersSquareOptions: { type: cornersSquareType, color: cornersSquareColor },
cornersDotOptions: { type: cornersDotType, color: cornersDotColor },
outputType,
width,
margin,
});
const { download } = useDownloadFileFromBase64({ source: qrcode, filename: 'qr-code.png' });
const qrcodeTerminal = computedAsync(() => {
const textValue = text.value;
const level = errorCorrectionLevel.value;
const small = smallTerminal.value;
return new Promise<string>((resolve, _reject) => {
try {
qrcodeConsole.setErrorLevel(level);
qrcodeConsole.generate(textValue, { small }, (qrcode: string) => {
resolve(qrcode);
});
}
catch (_) {
resolve('');
}
});
});
const filename = ref('qr-code');
const extension = computed(() => outputType.value.toString());
const { download } = useDownloadFileFromBase64({ source: qrcode, filename, extension });
</script>
<template>
@@ -46,8 +109,14 @@ const { download } = useDownloadFileFromBase64({ source: qrcode, filename: 'qr-c
<n-form-item label="Background color:">
<n-color-picker v-model:value="background" :modes="['hex']" />
</n-form-item>
<n-form-item label="Width:">
<n-input-number v-model:value="width" :min="0" />
</n-form-item>
<n-form-item label="Margin:">
<n-input-number v-model:value="margin" :min="0" />
</n-form-item>
<c-select
v-model:value="errorCorrectionLevel"
v-model:value="errorCorrectionLevelSelectValue"
label="Error resistance:"
label-position="left"
label-width="130px"
@@ -55,14 +124,104 @@ const { download } = useDownloadFileFromBase64({ source: qrcode, filename: 'qr-c
:options="errorCorrectionLevels.map((value) => ({ label: value, value }))"
/>
</n-form>
<c-card title="Image" mt-3>
<c-file-upload title="Drag and drop an image here, or click to select an image" @file-upload="onUpload" />
<n-form label-width="130" label-placement="left" mt-3>
<n-form-item label="Size:">
<n-input-number v-model:value="imageSize" :min="0" step="0.1" />
</n-form-item>
<n-form-item label="Margin:">
<n-input-number v-model:value="imageMargin" :min="0" />
</n-form-item>
</n-form>
</c-card>
<c-card mt-3>
<details>
<summary>Dots Options</summary>
<n-form label-width="130" label-placement="left">
<n-form-item label="Color:">
<n-color-picker v-model:value="dotColor" :modes="['hex']" />
</n-form-item>
<c-select
v-model:value="dotType"
label="Type:"
label-position="left"
label-width="130px"
label-align="right"
:options="dotTypes.map((value) => ({ label: value, value }))"
/>
</n-form>
</details>
</c-card>
<c-card mt-3>
<details>
<summary>Corners Dots Options</summary>
<n-form label-width="130" label-placement="left">
<n-form-item label="Color:">
<n-color-picker v-model:value="cornersDotColor" :modes="['hex']" />
</n-form-item>
<c-select
v-model:value="cornersDotType"
label="Type:"
label-position="left"
label-width="130px"
label-align="right"
:options="cornersDotTypes.map((value) => ({ label: value, value }))"
/>
</n-form>
</details>
</c-card>
<c-card mt-3>
<details>
<summary>Corners Square Options</summary>
<n-form label-width="130" label-placement="left">
<n-form-item label="Color:">
<n-color-picker v-model:value="cornersSquareColor" :modes="['hex']" />
</n-form-item>
<c-select
v-model:value="cornersSquareType"
label="Type:"
label-position="left"
label-width="130px"
label-align="right"
:options="cornersSquareTypes.map((value) => ({ label: value, value }))"
/>
</n-form>
</details>
</c-card>
<c-select
v-model:value="outputType"
mt-3
label="Output format:"
label-position="left"
label-width="130px"
label-align="right"
:options="outputTypes.map((value) => ({ label: value.toUpperCase(), value }))"
/>
</n-gi>
<n-gi>
<div flex flex-col items-center gap-3>
<n-image :src="qrcode" width="200" />
<c-button @click="download">
Download qr-code
Download qr-code ({{ outputType.toString().toUpperCase() }})
</c-button>
</div>
<n-divider />
<n-checkbox v-model:checked="smallTerminal">
Small Terminal
</n-checkbox>
<n-form-item label="Terminal output:" mt-1>
<TextareaCopyable
:value="qrcodeTerminal"
multiline
rows="5"
mb-1 mt-1
copy-placement="outside"
/>
</n-form-item>
</n-gi>
</n-grid>
</c-card>
@@ -0,0 +1,5 @@
declare module 'qrcode-terminal-nooctal' {
export const error: 0 | 1 | 2 | 3;
export function generate(input: string, opts?: { small: boolean }, callback?: (qrcode: string) => void): void;
export function setErrorLevel(error: "L" | "M" | "Q" | "H"): void;
}
+164 -15
View File
@@ -1,33 +1,182 @@
import { type MaybeRef, get } from '@vueuse/core';
import QRCode, { type QRCodeErrorCorrectionLevel, type QRCodeToDataURLOptions } from 'qrcode';
import QRCode, { type QRCodeDataURLType, type QRCodeErrorCorrectionLevel, type QRCodeRenderersOptions, type QRCodeStringType } from 'qrcode';
import { isRef, ref, watch } from 'vue';
import type {
CornerDotType,
CornerSquareType,
DotType,
DrawType,
ErrorCorrectionLevel,
FileExtension,
Mode,
TypeNumber,
} from 'pp-qr-code';
import QRCodeStyling from 'pp-qr-code';
export function useQRCode({
function blobToBase64(blob: Blob | null): Promise<string> {
if (blob === null) {
return Promise.resolve('');
}
return new Promise((resolve, _reject) => {
const reader = new FileReader();
reader.onloadend = () => resolve(reader.result as string);
reader.readAsDataURL(blob);
});
}
export function useQRCodeStyling({
text,
color: { background, foreground },
errorCorrectionLevel,
options,
imageBase64,
imageOptions: { imageSize, margin: imageMargin },
dotOptions: { type: dotType, color: dotColor },
cornersSquareOptions: { type: cornersSquareType, color: cornersSquareColor },
cornersDotOptions: { type: cornersDotType, color: cornersDotColor },
outputType,
width,
margin,
}: {
text: MaybeRef<string>
color: { foreground: MaybeRef<string>; background: MaybeRef<string> }
errorCorrectionLevel?: MaybeRef<QRCodeErrorCorrectionLevel>
options?: QRCodeToDataURLOptions
outputType: MaybeRef<FileExtension>
errorCorrectionLevel?: MaybeRef<ErrorCorrectionLevel>
imageBase64?: MaybeRef<string>
imageOptions: { imageSize: MaybeRef<number>; margin: MaybeRef<number> }
dotOptions: { type: MaybeRef<DotType>; color: MaybeRef<string> }
cornersSquareOptions: { type: MaybeRef<CornerSquareType>; color: MaybeRef<string> }
cornersDotOptions: { type: MaybeRef<CornerDotType>; color: MaybeRef<string> }
width?: MaybeRef<number>
margin?: MaybeRef<number>
}) {
const qrcode = ref('');
watch(
[text, background, foreground, errorCorrectionLevel].filter(isRef),
[text, background, foreground, errorCorrectionLevel,
imageBase64, imageSize, imageMargin,
dotType, dotColor, cornersSquareType, cornersSquareColor,
cornersDotType, cornersDotColor,
outputType, width, margin].filter(isRef),
async () => {
if (get(text)) {
qrcode.value = await QRCode.toDataURL(get(text).trim(), {
color: {
dark: get(foreground),
light: get(background),
...options?.color,
const qrCodeText = get(text)?.trim();
const qrCodeOutputType = get(outputType) || 'png';
if (qrCodeText) {
const getOrForeground = (colorRef: MaybeRef<string>) => {
const color = get(colorRef) || get(foreground);
if (color?.toLowerCase() === '#ffffffff') {
return get(foreground);
}
return color;
};
const qrCodeOptions = {
width: get(width) ?? 1024,
height: get(width) ?? 1024,
type: 'svg' as DrawType,
data: qrCodeText,
image: get(imageBase64),
margin: get(margin) || 10,
qrOptions: {
typeNumber: 0 as TypeNumber,
mode: 'Byte' as Mode,
errorCorrectionLevel: get(errorCorrectionLevel) || 'Q',
},
errorCorrectionLevel: get(errorCorrectionLevel) ?? 'M',
...options,
});
imageOptions: {
hideBackgroundDots: true,
imageSize: get(imageSize) || 0.4,
margin: get(imageMargin) || 20,
crossOrigin: 'anonymous',
},
dotsOptions: {
color: getOrForeground(dotColor),
// gradient: {
// type: 'linear', // 'radial'
// rotation: 0,
// colorStops: [{ offset: 0, color: '#8688B2' }, { offset: 1, color: '#77779C' }]
// },
type: get(dotType) || 'square',
},
backgroundOptions: {
color: get(background),
// gradient: {
// type: 'linear', // 'radial'
// rotation: 0,
// colorStops: [{ offset: 0, color: '#ededff' }, { offset: 1, color: '#e6e7ff' }]
// },
},
cornersSquareOptions: {
color: getOrForeground(cornersSquareColor),
type: get(cornersSquareType) || 'extra-rounded',
// gradient: {
// type: 'linear', // 'radial'
// rotation: 180,
// colorStops: [{ offset: 0, color: '#25456e' }, { offset: 1, color: '#4267b2' }]
// },
},
cornersDotOptions: {
color: getOrForeground(cornersDotColor),
type: get(cornersDotType) || 'dot',
// gradient: {
// type: 'linear', // 'radial'
// rotation: 180,
// colorStops: [{ offset: 0, color: '#00266e' }, { offset: 1, color: '#4060b3' }]
// },
},
};
const qrGenerator = new QRCodeStyling(qrCodeOptions);
qrcode.value = await blobToBase64(await qrGenerator.getRawData(qrCodeOutputType));
}
},
{ immediate: true },
);
return { qrcode };
}
export function useQRCode<QRCodeOptions extends QRCodeRenderersOptions>({
text,
color: { background, foreground },
errorCorrectionLevel,
outputType,
width,
options,
}: {
text: MaybeRef<string>
color: { foreground: MaybeRef<string>; background: MaybeRef<string> }
errorCorrectionLevel?: MaybeRef<QRCodeErrorCorrectionLevel>
outputType?: MaybeRef<QRCodeDataURLType | QRCodeStringType>
width?: MaybeRef<number>
options?: QRCodeOptions
}) {
const qrcode = ref('');
watch(
[text, background, foreground, errorCorrectionLevel, outputType, width].filter(isRef),
async () => {
const qrCodeText = get(text)?.trim();
const qrCodeType = get(outputType) || '';
if (qrCodeText) {
const qrCodeOptions = {
color: {
dark: get(foreground),
light: get(background),
...options?.color,
},
errorCorrectionLevel: get(errorCorrectionLevel) ?? 'M',
width: get(width) ?? 1024,
...options,
};
if (['utf8', 'svg', 'terminal'].includes(qrCodeType)) {
qrcode.value = await QRCode.toString(qrCodeText, {
type: qrCodeType as QRCodeStringType,
});
}
else {
qrcode.value = await QRCode.toDataURL(qrCodeText, {
...qrCodeOptions,
type: qrCodeType as QRCodeDataURLType,
});
}
}
},
{ immediate: true },